Skip to content

Commit d857e46

Browse files
committed
contrib : update roles
1 parent 4067f07 commit d857e46

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# Contributors
2+
3+
The project differentiates between 3 levels of contributors:
4+
5+
- Contributors: people who have contributed before (no special privileges)
6+
- Collaborators (Triage): people with significant contributions, who may be responsible for some parts of the code, and are expected to maintain and review contributions for the code they own
7+
- Maintainers: responsible for reviewing and merging PRs, after approval from the code owners
8+
19
# Pull requests (for contributors)
210

311
- llama.cpp uses the ggml tensor library for model evaluation. If you are unfamiliar with ggml, consider taking a look at the [examples in the ggml repository](https://github.com/ggml-org/ggml/tree/master/examples/). [simple](https://github.com/ggml-org/ggml/tree/master/examples/simple) shows the bare minimum for using ggml. [gpt-2](https://github.com/ggml-org/ggml/tree/master/examples/gpt-2) has minimal implementations for language model inference using GPT-2. [mnist](https://github.com/ggml-org/ggml/tree/master/examples/mnist) demonstrates how to train and evaluate a simple image classifier
@@ -12,11 +20,15 @@
1220

1321
# Pull requests (for collaborators)
1422

23+
- Maintainers will rely on your insights and approval when making a final decision to approve and merge a PR
24+
- Consider adding yourself to [CODEOWNERS](CODEOWNERS) to indicate your availability for reviewing related PRs
25+
26+
# Pull requests (for maintainers)
27+
1528
- Squash-merge PRs
1629
- Use the following format for the squashed commit title: `<module> : <commit title> (#<issue_number>)`. For example: `utils : fix typo in utils.py (#1234)`
1730
- Optionally pick a `<module>` from here: https://github.com/ggml-org/llama.cpp/wiki/Modules
18-
- Consider adding yourself to [CODEOWNERS](CODEOWNERS)
19-
- Let authors, who are also collaborators, merge their own PRs
31+
- Let other maintainers, merge their own PRs
2032
- When merging a PR by a contributor, make sure you have a good understanding of the changes
2133
- Be mindful of maintenance: most of the work going into a feature happens after the PR is merged. If the PR author is not committed to contribute long-term, someone else needs to take responsibility (you)
2234

@@ -117,6 +129,21 @@
117129
#endif // FOO
118130
```
119131
132+
# Code maintenance
133+
134+
- Existing code should have designated collaborators and/or maintainers specified in the [CODEOWNERS](CODEOWNERS) file reponsible for:
135+
- Reviewing and merging related PRs
136+
- Fixing related bugs
137+
- Providing developer guidance/support
138+
139+
- When adding or modifying a large piece of code:
140+
- If you are a collaborator, make sure to add yourself to [CODEOWNERS](CODEOWNERS) to indicate your availability for reviewing related PRs
141+
- If you are a contributor, find an existing collaborator who is willing to review and maintain your code long-term
142+
- Provide the necessary CI workflow (and hardware) to test your changes
143+
144+
- New code should follow the guidelines (coding, naming, etc.) outlined in this document. Exceptions are allowed in isolated, backend-specific parts of the code that do not interface directly with the `ggml` interfaces.
145+
_(NOTE: for legacy reasons, existing code is not required to follow this guideline)_
146+
120147
# Documentation
121148
122149
- Documentation is a community effort

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,8 +520,8 @@ To learn more about model quantization, [read this documentation](tools/quantize
520520
## Contributing
521521
522522
- Contributors can open PRs
523-
- Collaborators can push to branches in the `llama.cpp` repo and merge PRs into the `master` branch
524523
- Collaborators will be invited based on contributions
524+
- Maintainers can push to branches in the `llama.cpp` repo and merge PRs into the `master` branch
525525
- Any help with managing issues, PRs and projects is very appreciated!
526526
- See [good first issues](https://github.com/ggml-org/llama.cpp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for tasks suitable for first contributions
527527
- Read the [CONTRIBUTING.md](CONTRIBUTING.md) for more information

0 commit comments

Comments
 (0)