| title | description | tags | |||
|---|---|---|---|---|---|
AI Assistance Disclosure (CONTRIBUTING.md Template) |
CONTRIBUTING.md template section for disclosing AI tool usage in pull requests |
|
Copy this section into your project's CONTRIBUTING.md
If you use any AI tools to help with your contribution, please disclose this in your pull request description.
| AI Usage | Example Disclosure |
|---|---|
| AI-generated code | "This PR was written primarily by Claude Code" |
| AI-assisted research | "I consulted ChatGPT to understand the codebase" |
| AI-suggested approach | "Copilot suggested the algorithm structure" |
| AI-drafted docs | "Documentation was drafted with Claude assistance" |
- Trivial autocomplete (single keywords, short phrases)
- IDE syntax helpers (formatting, auto-imports)
- Grammar/spell checking
- Code formatting tools (prettier, black)
AI-generated code often requires more careful review:
- May use patterns unfamiliar to the codebase
- Could introduce subtle bugs humans wouldn't make
- Might miss project-specific conventions
- Sometimes "looks right" but has logical issues
Disclosure helps maintainers:
- Allocate review time appropriately
- Know where to look more carefully
- Provide better feedback on AI usage
This is a courtesy to reviewers, not a judgment on AI use.
In your PR description:
## AI Assistance
This PR was developed with assistance from [Tool Name].
Specifically:
- [What AI helped with]
- [What you did manually]
All code has been reviewed and understood by the author.Based on policies from:
For more context, see AI Traceability Guide.