Skip to content

Comments

Add AI usage disclosure guidelines to CONTRIBUTING.md#704

Merged
curquiza merged 1 commit intomainfrom
meili-bot/add-ai-disclosure-guidelines
Jan 19, 2026
Merged

Add AI usage disclosure guidelines to CONTRIBUTING.md#704
curquiza merged 1 commit intomainfrom
meili-bot/add-ai-disclosure-guidelines

Conversation

@meili-bot
Copy link
Contributor

@meili-bot meili-bot commented Jan 19, 2026

This PR is auto-generated.

This PR adds guidelines about AI tool usage in contributions:

  • New "Coding with AI" section explaining our policy on AI-assisted contributions
  • Reminder in step 5 of "How to Contribute" about disclosing AI usage

Our policy: AI usage is accepted, provided contributors disclose it in their PR description. This transparency helps maintainers during code review.

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines to reflect new AI-assisted development practices and disclosure requirements for contributors.

✏️ Tip: You can customize this high-level summary in your review settings.

@meili-bot meili-bot added the documentation Improvements or additions to documentation label Jan 19, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 19, 2026

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
AI Contribution Guidelines
CONTRIBUTING.md
Added new "Coding with AI" section establishing disclosure requirements for AI-assisted work, guidelines for specifying AI-assisted scope, and content review expectations. Updated contributor workflow step 5 to mandate AI usage disclosure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A carrot-scented guideline grows,
Where human hearts and AI flows,
Transparency blooms with each disclosure,
Building trust through open closure,
Hop along, contributors bold!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main change: adding AI usage disclosure guidelines to CONTRIBUTING.md, which directly matches the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
⚠️ 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.

@curquiza curquiza added this pull request to the merge queue Jan 19, 2026
Merged via the queue into main with commit f90e26e Jan 19, 2026
4 checks passed
@curquiza curquiza deleted the meili-bot/add-ai-disclosure-guidelines branch January 19, 2026 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants