Skip to content

Commit ee981e2

Browse files
ggerganovarthw
authored andcommitted
contrib : simplify + minor edits [no ci]
1 parent fb48e7a commit ee981e2

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
# Pull requests (for contributors)
22

33
- Test your changes:
4-
- Using the commands in the [`tests`](tests) folder. For instance, running the `./tests/test-backend-ops` command tests different backend implementations of the GGML library
4+
- Using the commands in the [`tests`](tests) folder. For instance, running the `./tests/test-backend-ops` command tests different backend implementations of the `ggml` library
55
- Execute [the full CI locally on your machine](ci/README.md) before publishing
6-
- Please rate the complexity of your PR (i.e. `Review Complexity : Low`, `Review Complexity : Medium`, `Review Complexity : High`). This makes it easier for maintainers to triage the PRs.
7-
- The PR template has a series of review complexity checkboxes `[ ]` that [you can mark as](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) `[X]` for your convenience
8-
- Consider allowing write access to your branch for faster review
6+
- Optionally rate the complexity of your PR (i.e. `Review Complexity : Low`, `Review Complexity : Medium`, `Review Complexity : High`). This makes it easier for maintainers to triage the PRs
7+
- Consider allowing write access to your branch for faster reviews, as reviewers can push commits directly
98
- If your PR becomes stale, don't hesitate to ping the maintainers in the comments
109

1110
# Pull requests (for collaborators)
1211

1312
- Squash-merge PRs
1413
- Use the following format for the squashed commit title: `<module> : <commit title> (#<issue_number>)`. For example: `utils : fix typo in utils.py (#1234)`
15-
- Optionally, pick a `<module>` from here: https://github.com/ggerganov/llama.cpp/wiki/Modules
14+
- Optionally pick a `<module>` from here: https://github.com/ggerganov/llama.cpp/wiki/Modules
1615

1716
# Coding guidelines
1817

1918
- Avoid adding third-party dependencies, extra files, extra headers, etc.
2019
- Always consider cross-compatibility with other operating systems and architectures
21-
- Avoid fancy looking modern STL constructs, use basic `for` loops, avoid templates, keep it simple
20+
- Avoid fancy-looking modern STL constructs, use basic `for` loops, avoid templates, keep it simple
2221
- There are no strict rules for the code style, but try to follow the patterns in the code (indentation, spaces, etc.). Vertical alignment makes things more readable and easier to batch edit
2322
- Clean-up any trailing whitespaces, use 4 spaces for indentation, brackets on the same line, `void * ptr`, `int & a`
2423
- Naming usually optimizes for common prefix (see https://github.com/ggerganov/ggml/pull/302#discussion_r1243240963)

0 commit comments

Comments
 (0)