Skip to content

Conversation

@M4dhav
Copy link

@M4dhav M4dhav commented Feb 4, 2026

This PR adds a section to Contributing.MD about Coding with AI

Checklist

  • My code follows the project's code style and conventions
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contributing Guidelines

⚠️ AI Notice - Important!

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with new section on AI-assisted contributions, including guidelines on acceptable usage, disclosure requirements, and expectations for contributors using AI tools.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

Added a new "Coding with AI" section to CONTRIBUTING.md that outlines policy guidance on AI-assisted contributions, including disclosure requirements and acceptable usage expectations. The changes are purely additive documentation with no modifications to existing content or logic.

Changes

Cohort / File(s) Summary
Documentation Update
CONTRIBUTING.md
Added new "Coding with AI" section to Table of Contents and included detailed guidance on acceptable AI usage, disclosure requirements, and expectations for AI-assisted contributions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

documentation, no-issue-linked, size/S

Suggested reviewers

  • Zahnentferner

Poem

🐰 With whiskers twitching, I hop with glee,
Your AI policy is clear for all to see!
Disclosure shines bright, transparency gleams,
Hoppy contributions from human and machine! ✨

🚥 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 'Add Coding with AI Section' directly and clearly summarizes the main change: adding a new section to CONTRIBUTING.md about coding with AI.
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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@github-actions github-actions bot added size/S and removed size/S labels Feb 4, 2026
Copy link
Contributor

@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 59: Update the sentence "This helps maintainers during code review and
ensure the quality of contributions." to fix subject-verb agreement by changing
"ensure" to "ensures" so it reads "This helps maintainers during code review and
ensures the quality of contributions."; locate and replace the exact phrase in
the CONTRIBUTING.md sentence shown in the diff to preserve surrounding
punctuation and formatting.


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
Contributor

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.

The verb "ensure" should be "ensures" to maintain subject-verb agreement with the singular subject "This" and to parallel the earlier verb "helps."

📝 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 59, Update the sentence "This helps maintainers
during code review and ensure the quality of contributions." to fix subject-verb
agreement by changing "ensure" to "ensures" so it reads "This helps maintainers
during code review and ensures the quality of contributions."; locate and
replace the exact phrase in the CONTRIBUTING.md sentence shown in the diff to
preserve surrounding punctuation and formatting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant