|
2 | 2 | We want to make contributing to this project as easy and transparent as
|
3 | 3 | possible.
|
4 | 4 |
|
5 |
| -## AI Assistance Notice |
| 5 | +## AI Assistance Best Practices |
6 | 6 |
|
7 |
| -> [!IMPORTANT] |
8 |
| -> |
9 |
| -> If you are using **any kind of AI assistance** to contribute to Llama Stack, |
10 |
| -> it must be disclosed in the pull request. |
11 |
| -
|
12 |
| -If you are using any kind of AI assistance while contributing to Llama Stack, |
13 |
| -**this must be disclosed in the pull request**, along with the extent to |
14 |
| -which AI assistance was used (e.g. docs only vs. code generation). |
15 |
| -If PR responses are being generated by an AI, disclose that as well. |
16 |
| - |
17 |
| -An example disclosure: |
| 7 | +AI-assisted coding has changed the nature of contributions. AI tools can now generate large volumes of (typically) low-quality code quickly, increasing the burden on reviewers and reducing opportunities for meaningful feedback. As a result, we urge contributors to disclose _how_ they used AI assistance and follow the best practices below. |
18 | 8 |
|
19 |
| -> This PR was written primarily by Claude Code. |
| 9 | +Contributors could attest to: |
20 | 10 |
|
21 |
| -Or a more detailed disclosure: |
| 11 | +- "I've reviewed and understood all code before submitting." |
| 12 | +- "I've tested the changes and ensured they address only the issue at hand." |
| 13 | +- "I've asked an AI system to review this code." |
| 14 | +- "I've refined any AI-generated output to meet our standards." |
| 15 | +- "I've looked at generated tests and ensured they are meaningful. e.g., they avoid using fragile mocks." |
22 | 16 |
|
23 |
| -> I consulted ChatGPT to understand the codebase but the solution |
24 |
| -> was fully authored manually by myself. |
25 |
| -
|
26 |
| -Failure to disclose this is first and foremost rude to the human operators |
27 |
| -on the other end of the pull request, but it also makes it difficult to |
28 |
| -determine how much scrutiny to apply to the contribution. |
29 |
| - |
30 |
| -Please be respectful to maintainers and disclose AI assistance. |
| 17 | +> [!IMPORTANT] |
| 18 | +> We would like to move the emphasis from whether AI was used to _how_ it was used and what human oversight was applied. |
31 | 19 |
|
32 | 20 | ## Set up your development environment
|
33 | 21 |
|
|
0 commit comments