Skip to content

Commit a408911

Browse files
Add AI assistance disclosure requirements to contributing guidelines
Added comprehensive AI Assistance Notice section based on ghostty-org/ghostty#8289 - Requires disclosure of AI tool usage in PRs - Provides clear examples and guidelines - Explains reasoning for transparency policy Co-Authored-By: Sahil Lavingia <sahil@gumroad.com>
1 parent d7c176e commit a408911

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,47 @@ We don't assign issues to contributors until they have a history of contribution
7373
- Use factories for test data instead of creating objects directly
7474
- Test both happy path and edge cases
7575

76+
## AI Assistance Notice
77+
78+
We require disclosure of AI assistance in pull requests to maintain transparency and help reviewers understand the contribution process. This helps us:
79+
80+
- Understand the development process behind contributions
81+
- Provide appropriate review and feedback
82+
- Maintain code quality standards
83+
- Build trust within our contributor community
84+
85+
### Disclosure Requirements
86+
87+
When submitting a pull request that involved AI assistance (such as GitHub Copilot, ChatGPT, Claude, or similar tools), please include a brief note in your PR description indicating:
88+
89+
1. **What AI tools were used** (if any)
90+
2. **How they were used** (code generation, debugging, documentation, etc.)
91+
3. **What portions of the contribution involved AI assistance**
92+
93+
### Examples
94+
95+
**Good disclosure examples:**
96+
- "Used GitHub Copilot for boilerplate code generation in the new authentication module"
97+
- "ChatGPT helped debug the memory leak in the connection pool implementation"
98+
- "Claude assisted with writing unit tests for the new API endpoints"
99+
- "No AI assistance was used in this contribution"
100+
101+
**What doesn't need disclosure:**
102+
- Standard IDE features (autocomplete, syntax highlighting, etc.)
103+
- Search engines and documentation lookup
104+
- Stack Overflow and similar Q&A sites
105+
106+
### Why We Ask
107+
108+
This policy isn't about restricting AI use—we recognize AI tools can be valuable development aids. Instead, it's about transparency and helping our maintainers provide the best possible review. Knowing how a contribution was developed helps us:
109+
110+
- Focus review attention appropriately
111+
- Provide better feedback and mentorship
112+
- Understand patterns in our codebase development
113+
- Make informed decisions about our development practices
114+
115+
Thank you for helping us maintain a transparent and collaborative development environment!
116+
76117
## License
77118

78119
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).

0 commit comments

Comments
 (0)