Add AI usage disclosure guidelines to CONTRIBUTING.md#704
Conversation
📝 WalkthroughWalkthroughThis update introduces a new "Coding with AI" section to CONTRIBUTING.md that establishes guidelines for AI-assisted contributions. It requires contributors to disclose AI tool usage in pull request descriptions, specify the scope of AI assistance, and ensures AI-generated content undergoes proper review. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Line 16: Fix the subject–verb agreement in the sentence that reads “This helps
maintainers during code review and ensure the quality of contributions” by
changing “ensure” to “ensures” so the verbs agree with the singular subject
“This”; update the sentence text accordingly in CONTRIBUTING.md.
|
|
||
| We accept the use of AI-powered tools (GitHub Copilot, ChatGPT, Claude, Cursor, etc.) for contributions, whether for code, tests, or documentation. | ||
|
|
||
| ⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensure the quality of contributions. |
There was a problem hiding this comment.
Fix subject–verb agreement.
“helps maintainers … and ensure” should be “helps maintainers … and ensures”.
Proposed fix
-⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensure the quality of contributions.
+⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensures the quality of contributions.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensure the quality of contributions. | |
| ⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensures the quality of contributions. |
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 16, Fix the subject–verb agreement in the sentence
that reads “This helps maintainers during code review and ensure the quality of
contributions” by changing “ensure” to “ensures” so the verbs agree with the
singular subject “This”; update the sentence text accordingly in
CONTRIBUTING.md.
This PR is auto-generated.
This PR adds guidelines about AI tool usage in contributions:
Our policy: AI usage is accepted, provided contributors disclose it in their PR description. This transparency helps maintainers during code review.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.