This commit is contained in:
Ashwin Bharambe 2025-08-22 09:28:54 -07:00
parent b30390dc88
commit 7bcce1f05a

View file

@ -2,32 +2,20 @@
We want to make contributing to this project as easy and transparent as We want to make contributing to this project as easy and transparent as
possible. possible.
## AI Assistance Notice ## AI Assistance Best Practices
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.
Contributors could attest to:
- "I've reviewed and understood all code before submitting."
- "I've tested the changes and ensured they address only the issue at hand."
- "I've asked an AI system to review this code."
- "I've refined any AI-generated output to meet our standards."
- "I've looked at generated tests and ensured they are meaningful. e.g., they avoid using fragile mocks."
> [!IMPORTANT] > [!IMPORTANT]
> > We would like to move the emphasis from whether AI was used to _how_ it was used and what human oversight was applied.
> If you are using **any kind of AI assistance** to contribute to Llama Stack,
> it must be disclosed in the pull request.
If you are using any kind of AI assistance while contributing to Llama Stack,
**this must be disclosed in the pull request**, along with the extent to
which AI assistance was used (e.g. docs only vs. code generation).
If PR responses are being generated by an AI, disclose that as well.
An example disclosure:
> This PR was written primarily by Claude Code.
Or a more detailed disclosure:
> I consulted ChatGPT to understand the codebase but the solution
> was fully authored manually by myself.
Failure to disclose this is first and foremost rude to the human operators
on the other end of the pull request, but it also makes it difficult to
determine how much scrutiny to apply to the contribution.
Please be respectful to maintainers and disclose AI assistance.
## Set up your development environment ## Set up your development environment