[META] AI policy#7914
Conversation
📝 WalkthroughWalkthroughThis PR establishes contribution governance by introducing an AI policy framework across three documentation surfaces: CONTRIBUTING.md is restructured to front-load the policy and set expectations; a new PR template enforces acknowledgment at submission time; and README is simplified to direct contributors to the full guidelines. ChangesContribution Framework Setup
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
| <!-- | ||
| Thanks for your contribution! | ||
|
|
||
| TBD |
There was a problem hiding this comment.
I'm not quite sure what to write here, any suggestions? @fanninpm @youknowone
There was a problem hiding this comment.
You could start with these sections:
- What changed: Requesting a description of what the pull request changes in the human's own words. Here the contributor can disclose the use of AI assistance, if applicable. (Coderabbit will make its own summary)
- Motivation: Requesting an explanation of why the pull request was made in the human's own words. (Language such as
Closes #WXYZshould suffice, given some criteria [TODO: should be defined] that the linked issue has to meet.) - Verification: Requesting a summary of what steps were taken to verify the effectiveness of the PR's changes.
- Checklist: Something like (with language to be refined):
- If I changed something that impacts Rust code, I can confirm that I ran
cargo whateverwith no errors. (If not, please explain why.) - I can confirm that I ran (whatever other tool or tools (for the next few bullet points)) (If not, please explain why.)
- If I have used AI assistance, I have disclosed it as such.
- I understand that others, including the RustPython maintainers, will ask me questions about this pull request
- I will respond to these questions in my own words to the best of my ability.
- I understand that the RustPython maintainers will close my pull request if I do not check any of these boxes.
- If I changed something that impacts Rust code, I can confirm that I ran
If you have anything to add to the checklist, it is a good idea to use the active voice in a manner similar to how I wrote the previous bullet points.
Separately from this PR, I think it would be a good idea to convert our Issue templates from Markdown into YAML format.
There was a problem hiding this comment.
I liked that idea a lot. I've looked around in couple of FOSS projects and took what I liked. If you have a checkbox you would like to add/remove, please feel free to say (or even push it straight to my branch)
There was a problem hiding this comment.
Separately from this PR, I think it would be a good idea to convert our Issue templates from Markdown into YAML format
I'll look into that:)
There was a problem hiding this comment.
Added CONTRIBUTING.md as it's standardized https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributingmd-file
Should we merge DEVELOPMENT. md into it?
feels redundant two have two separate files for the same thing, no?
There was a problem hiding this comment.
having both CONTRIBUTING and DEVELOPMENT doesn't make sense. yeah, mv DEVELOPMENT and patch it please.
There was a problem hiding this comment.
The DEVELOPMENT. md is pretty outdated, I'll refresh it in a follow PR. I'd rather keep this PR small
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 20-21: CONTRIBUTING.md references a non-existent AI policy at
https://github.com/RustPython/.github/blob/main/AI_POLICY.md; add the missing
AI_POLICY.md to the RustPython/.github repository (or update the link in
CONTRIBUTING.md) so the referenced policy exists. Create a clear AI_POLICY.md
file containing the project's AI usage rules and place it in the .github
repository root, then verify CONTRIBUTING.md's link points to that new file (or
change the link to an existing policy file) to ensure the guideline resolves
correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: f1fa9bc3-418a-4cd4-b7f3-45c8916a108f
📒 Files selected for processing (3)
.github/PULL_REQUEST_TEMPLATE.mdCONTRIBUTING.mdREADME.md
| We **require all use of AI in contributions to follow our | ||
| [AI Policy](https://github.com/RustPython/.github/blob/main/AI_POLICY.md)**. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the AI policy document exists and is accessible
# Check if the AI policy file exists in the .github repository
gh api repos/RustPython/.github/contents/AI_POLICY.md --jq '.name' 2>/dev/null || echo "AI_POLICY.md not found in RustPython/.github repository"
# Also check the raw content availability
curl -s -o /dev/null -w "%{http_code}" https://raw.githubusercontent.com/RustPython/.github/main/AI_POLICY.mdRepository: RustPython/RustPython
Length of output: 251
The referenced AI policy document does not exist and must be created before merging.
The contribution guidelines require contributors to follow an AI policy at https://github.com/RustPython/.github/blob/main/AI_POLICY.md, but this document is not currently available in the RustPython/.github repository. The policy cannot be enforced or followed by contributors without this document. Either create the AI_POLICY.md file in the RustPython/.github repository or update the reference to point to an existing document.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 20 - 21, CONTRIBUTING.md references a
non-existent AI policy at
https://github.com/RustPython/.github/blob/main/AI_POLICY.md; add the missing
AI_POLICY.md to the RustPython/.github repository (or update the link in
CONTRIBUTING.md) so the referenced policy exists. Create a clear AI_POLICY.md
file containing the project's AI usage rules and place it in the .github
repository root, then verify CONTRIBUTING.md's link points to that new file (or
change the link to an existing policy file) to ensure the guideline resolves
correctly.
3 participants
Summary by CodeRabbit