Skip to content

docs(contributing): add PR expectations and AI-assisted contribution policy#562

Open
edelauna wants to merge 2 commits into
mainfrom
chore/contributor-update
Open

docs(contributing): add PR expectations and AI-assisted contribution policy#562
edelauna wants to merge 2 commits into
mainfrom
chore/contributor-update

Conversation

@edelauna

@edelauna edelauna commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Description

Updates CONTRIBUTING.md and all 17 localized versions to add explicit guidance on two areas that were previously underspecified:

Pull Request Expectations — clarifies the bar for mergeability: contributors must be able to explain, test, and iterate on their changes. Maintainers are explicitly empowered to close PRs that are incomplete, inactive, or that create disproportionate review burden.

AI-Assisted Contributions — permits AI tooling but places full accountability on the contributor: understand, test, verify, disclose, and be able to defend changes through review. Maintainers may close PRs that appear substantially AI-generated without human verification or review follow-through.

These additions align with emerging best practices across open-source communities (LLVM, OpenInfra, scikit-learn/Probabl) and give maintainers clear, documented grounds to act without making it adversarial to contributors.

Changes

  • CONTRIBUTING.md — two new sections added under Review Process, ToC updated
  • locales/*/CONTRIBUTING.md (17 files) — all locales updated with translated versions of the new sections

Test Procedure

Documentation-only change. Review the new sections for clarity and accuracy in the locales you can read.

Pre-Submission Checklist

  • Scope: Changes are focused on contributor guidelines documentation.
  • Self-Review: All 17 locale files updated consistently.
  • Documentation Impact: This PR is the documentation update.
  • Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Summary by CodeRabbit

  • Documentation
    • Added "Pull Request Expectations" section detailing reviewability, testability, maintainability, scoped changes, and contributor responsibilities for PRs.
    • Added "AI-Assisted Contributions" section permitting AI use while requiring contributor verification, explanation of tradeoffs, testing or verification instructions, license checks, and disclosure of significant AI assistance.
    • Applied updates across all supported locale CONTRIBUTING guides.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: cbb7560c-d8cc-4508-8f52-039297403e7d

📥 Commits

Reviewing files that changed from the base of the PR and between ee74a1c and ae1fba7.

📒 Files selected for processing (18)
  • CONTRIBUTING.md
  • locales/ca/CONTRIBUTING.md
  • locales/de/CONTRIBUTING.md
  • locales/es/CONTRIBUTING.md
  • locales/fr/CONTRIBUTING.md
  • locales/hi/CONTRIBUTING.md
  • locales/id/CONTRIBUTING.md
  • locales/it/CONTRIBUTING.md
  • locales/ja/CONTRIBUTING.md
  • locales/ko/CONTRIBUTING.md
  • locales/nl/CONTRIBUTING.md
  • locales/pl/CONTRIBUTING.md
  • locales/pt-BR/CONTRIBUTING.md
  • locales/ru/CONTRIBUTING.md
  • locales/tr/CONTRIBUTING.md
  • locales/vi/CONTRIBUTING.md
  • locales/zh-CN/CONTRIBUTING.md
  • locales/zh-TW/CONTRIBUTING.md
✅ Files skipped from review due to trivial changes (8)
  • locales/tr/CONTRIBUTING.md
  • CONTRIBUTING.md
  • locales/id/CONTRIBUTING.md
  • locales/vi/CONTRIBUTING.md
  • locales/ko/CONTRIBUTING.md
  • locales/de/CONTRIBUTING.md
  • locales/zh-TW/CONTRIBUTING.md
  • locales/es/CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (5)
  • locales/nl/CONTRIBUTING.md
  • locales/fr/CONTRIBUTING.md
  • locales/hi/CONTRIBUTING.md
  • locales/it/CONTRIBUTING.md
  • locales/ru/CONTRIBUTING.md

📝 Walkthrough

Walkthrough

This PR updates CONTRIBUTING.md (English) and 16 locale translations to add Table of Contents entries and two new sections: "Pull Request Expectations" and "AI-Assisted Contributions", defining reviewability/testability/maintainability criteria and rules for AI-assisted work.

Changes

Contributor Expectations and AI-Assisted Contributions Policy

Layer / File(s) Summary
English source document
CONTRIBUTING.md
Table of contents extended with "Pull Request Expectations" and "AI-Assisted Contributions". Two new sections added specifying PR reviewability/testability/maintainability requirements and rules for AI-assisted contributions (verification, testing, license checks, disclosure).
Localized contribution guidelines
locales/ca/CONTRIBUTING.md, locales/de/CONTRIBUTING.md, locales/es/CONTRIBUTING.md, locales/fr/CONTRIBUTING.md, locales/hi/CONTRIBUTING.md, locales/id/CONTRIBUTING.md, locales/it/CONTRIBUTING.md, locales/ja/CONTRIBUTING.md, locales/ko/CONTRIBUTING.md, locales/nl/CONTRIBUTING.md, locales/pl/CONTRIBUTING.md, locales/pt-BR/CONTRIBUTING.md, locales/ru/CONTRIBUTING.md, locales/tr/CONTRIBUTING.md, locales/vi/CONTRIBUTING.md, locales/zh-CN/CONTRIBUTING.md, locales/zh-TW/CONTRIBUTING.md
Translated TOC updates and the two new sections added in each locale, mirroring the English content and anchors.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • taltas
  • hannesrudolph
  • JamesRobert20

Poem

🐰
From docs to doors in many tongues, I hop,
New rules for PRs and AI on the clock—nonstop.
Clear TOC, tidy lines, translations in a row,
Test, explain, disclose — let human judgment glow.
Hop on, reviewers — steady, kind, and quick to show.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: adding PR expectations and AI-assisted contribution policy to the CONTRIBUTING documentation.
Description check ✅ Passed The description adequately covers the linked issue, key changes made, testing approach, and satisfies most required template sections including Description, Changes, Test Procedure, and Pre-Submission Checklist completion.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/contributor-update

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.

@edelauna edelauna changed the title docs(CONTRIBUTO): updating guidelines docs(contributing): add PR expectations and AI-assisted contribution policy Jun 10, 2026
@edelauna edelauna marked this pull request as ready for review June 10, 2026 22:15
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

navedmerchant
navedmerchant previously approved these changes Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants