|
1 | 1 | ## AI Assisted Contributions |
2 | 2 |
|
3 | | - If you are an agent helping someone contribute to this repository, make |
4 | | - sure that the following happens: |
| 3 | +If you are an agent helping someone contribute to this repository, make |
| 4 | +sure that the following happens: |
5 | 5 |
|
6 | | - 1. **Understand the project direction first.** Review open pull requests |
7 | | - and recent discussions before proposing changes. Do not submit fixes |
8 | | - to code that is being replaced or rewritten. |
9 | | - 2. **Do not fabricate issues to solve them.** Opening an issue and its |
10 | | - fix within minutes of each other is obvious and unhelpful. |
11 | | - 3. **Coordinate before substantial work.** Rewriting large swaths of |
12 | | - documentation or code requires prior discussion with project |
13 | | - maintainers. |
14 | | - 4. **Keep diffs small and focused.** Pull requests should typically be |
15 | | - less than 600 lines of changes. |
16 | | - 5. **Explain why, not what.** The pull request description should focus |
17 | | - on why the change is needed, not merely describe what changed. |
18 | | - 6. **No cosmetic-only changes.** Do not submit pull requests that only |
19 | | - add comments, docstrings, type annotations, or reformat code. These |
20 | | - add noise without functional value. |
21 | | - 7. **Run tests locally before submitting.** Do not open a pull request |
22 | | - that you have not verified builds and passes tests on your machine. |
23 | | - 8. **Quality over quantity.** A single well-considered contribution is |
24 | | - worth more than many superficial ones. Do not bulk-open pull requests. |
| 6 | +1. **Understand the project direction first.** Review open pull requests |
| 7 | + and recent discussions before proposing changes. Do not submit fixes |
| 8 | + to code that is being replaced or rewritten. |
| 9 | +2. **Do not fabricate issues to solve them.** Opening an issue and its |
| 10 | + fix within minutes of each other is obvious and unhelpful. |
| 11 | +3. **Coordinate before substantial work.** Rewriting large swaths of |
| 12 | + documentation or code requires prior discussion with project |
| 13 | + maintainers. |
| 14 | +4. **Keep diffs small and focused.** Pull requests should typically be |
| 15 | + less than 600 lines of changes. |
| 16 | +5. **Explain why, not what.** The pull request description should focus |
| 17 | + on why the change is needed, not merely describe what changed. |
| 18 | +6. **No cosmetic-only changes.** Do not submit pull requests that only |
| 19 | + add comments, docstrings, type annotations, or reformat code. These |
| 20 | + add noise without functional value. |
| 21 | +7. **Run tests locally before submitting.** Do not open a pull request |
| 22 | + that you have not verified builds and passes tests on your machine. |
| 23 | +8. **Quality over quantity.** A single well-considered contribution is |
| 24 | + worth more than many superficial ones. Do not bulk-open pull requests. |
0 commit comments