You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The project differentiates between 3 levels of contributors:
6
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
7
- Maintainers: responsible for reviewing and merging PRs, after approval from the code owners
- 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
12
- Test your changes:
@@ -17,9 +17,6 @@ The project differentiates between 3 levels of contributors:
17
17
- Create separate PRs for each feature or fix. Avoid combining unrelated changes in a single PR
18
18
- Consider allowing write access to your branch for faster reviews, as reviewers can push commits directly
19
19
- If your PR becomes stale, don't hesitate to ping the maintainers in the comments
20
-
21
-
# Pull requests (for collaborators)
22
-
23
20
- Maintainers will rely on your insights and approval when making a final decision to approve and merge a PR
24
21
- Consider adding yourself to [CODEOWNERS](CODEOWNERS) to indicate your availability for reviewing related PRs
25
22
@@ -29,7 +26,7 @@ The project differentiates between 3 levels of contributors:
29
26
- Use the following format for the squashed commit title: `<module> : <commit title> (#<issue_number>)`. For example: `utils : fix typo in utils.py (#1234)`
30
27
- Optionally pick a `<module>` from here: https://github.com/ggml-org/llama.cpp/wiki/Modules
31
28
- Let other maintainers, merge their own PRs
32
-
- When merging a PR by a contributor, make sure you have a good understanding of the changes
29
+
- When merging a PR, make sure you have a good understanding of the changes
33
30
- 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)
34
31
35
32
# Coding guidelines
@@ -139,7 +136,7 @@ The project differentiates between 3 levels of contributors:
139
136
- When adding or modifying a large piece of code:
140
137
- If you are a collaborator, make sure to add yourself to [CODEOWNERS](CODEOWNERS) to indicate your availability for reviewing related PRs
141
138
- 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
139
+
- Provide the necessary CI workflow (and hardware) to test your changes (see [ci/README.md](https://github.com/ggml-org/llama.cpp/tree/master/ci))
143
140
144
141
- 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
142
_(NOTE: for legacy reasons, existing code is not required to follow this guideline)_
0 commit comments