Skip to content

Commit 6676362

Browse files
ggerganovarthw
authored andcommitted
contrib : clarify PR squashing + module names (ggml-org#8630)
* contrib : clarify PR squashing * contrib : fix typo + add list of modules
1 parent a9c03e4 commit 6676362

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
# Pull requests
1+
# Pull requests (for contributors)
22

3-
- Always squash-merge the PR before merging
4-
- Use the following format for your final commit: `<module> : <commit title> (#<issue_number>)`. For example: `utils : fix typo in utils.py (#1234)`
53
- Test your changes:
64
- 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
75
- Execute [the full CI locally on your machine](ci/README.md) before publishing
86
- 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.
9-
- 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 conveience
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+
- If your PR becomes stale, don't hesitate to ping the maintainers in the comments
9+
10+
# Pull requests (for collaborators)
11+
12+
- Squash-merge PRs
13+
- Use the following format for the squashed commit title: `<module> : <commit title> (#<issue_number>)`. For example: `utils : fix typo in utils.py (#1234)`
14+
- Optionally, pick a `<module>` from here: https://github.com/ggerganov/llama.cpp/wiki/Modules
1015

1116
# Coding guidelines
1217

0 commit comments

Comments
 (0)