docs: add AI assistance disclosure to the PR template - #2261
Conversation
Signed-off-by: AswaniSahoo <aswanisahoo1012@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: AswaniSahoo The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @AswaniSahoo! It looks like this is your first PR to Project-HAMi/HAMi 🎉 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe pull request template now includes AI assistance disclosure guidance, a link to the AI Assistance Notice, a Contribution Gates acknowledgment, and confirmation that authors wrote their review replies. Trivial tab completion is excluded. ChangesContribution process
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
mesutoezdil
left a comment
There was a problem hiding this comment.
direction is right, three asks: rename the header to "AI assistance disclosure" so it matches what contributors already write and a future ci check can grep for it, put the "write None if unused" instruction in visible text w/ the CONTRIBUTING link so a blank field is not ambiguous, and add a checkbox like "- [ ] i have read the contribution gates and understand review replies must be written by me, not by an ai". nit: add the missing trailing newline while here.
|
Agree with @mesutoezdil |
Signed-off-by: AswaniSahoo <aswanisahoo1012@gmail.com>
|
Pushed as 7f9c861. Renamed the field to Pulled the "write Added the checkbox, pointed at Contribution Gates rather than free text, since gate 4 already says the reply has to be written by the author. Felt better to reference the rule than restate it. Newline fixed. One I wasn't sure on: I kept the trivial tab completion exception in the html comment and only lifted the |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
/assign @mesutoezdil |
|
You can view the relevant rule here. |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
CONTRIBUTING.md requires that any use of AI assistance be disclosed in the pull request, along with the extent of it. The PR template does not ask for this, so the requirement is easy to miss — in #2046 the disclosure was added only after a reviewer asked for it.
This adds a "Was AI assistance used in this PR?" field pointing at the AI Assistance Notice, including the exception that notice already makes for trivial tab-completion.
Which issue(s) this PR fixes:
None — raised by @mesutoezdil during review of #2046.
Special notes for your reviewer:
@mesutoezdil suggested this in #2046 and asked @spencercjh to open it; opening here since it hasn't landed yet — happy to close if one is already in flight.
The wording follows the existing AI Assistance Notice in CONTRIBUTING.md rather than introducing any new policy.
Was AI assistance used in this PR?:
Yes — Claude Code, to locate the CONTRIBUTING.md requirement and draft the template wording. I reviewed the result and take responsibility for its accuracy.
Does this PR introduce a user-facing change?:
NONE
Summary by CodeRabbit