Skip to content

docs: add AI assistance disclosure to the PR template - #2261

Closed
AswaniSahoo wants to merge 2 commits into
Project-HAMi:masterfrom
AswaniSahoo:docs/pr-template-ai-disclosure
Closed

docs: add AI assistance disclosure to the PR template#2261
AswaniSahoo wants to merge 2 commits into
Project-HAMi:masterfrom
AswaniSahoo:docs/pr-template-ai-disclosure

Conversation

@AswaniSahoo

@AswaniSahoo AswaniSahoo commented Aug 1, 2026

Copy link
Copy Markdown

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

  • Documentation
    • Updated the pull request template with an AI assistance disclosure section.
    • Added guidance for reporting AI usage and AI-generated review-comment replies.
    • Added a Contribution Gates acknowledgment checkbox and an exception for trivial tab completion.

Signed-off-by: AswaniSahoo <aswanisahoo1012@gmail.com>
@hami-robot hami-robot Bot added kind/documentation Improvements or additions to documentation dco-signoff: yes labels Aug 1, 2026
@hami-robot

hami-robot Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: AswaniSahoo
Once this PR has been reviewed and has the lgtm label, please assign wawa0210 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@hami-robot

hami-robot Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Welcome @AswaniSahoo! It looks like this is your first PR to Project-HAMi/HAMi 🎉

@hami-robot hami-robot Bot added the size/XS label Aug 1, 2026
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5fc410f1-0747-462e-b484-cc8b1eecd5cc

📥 Commits

Reviewing files that changed from the base of the PR and between 2909bc1 and 7f9c861.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/PULL_REQUEST_TEMPLATE.md

📝 Walkthrough

Walkthrough

The 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.

Changes

Contribution process

Layer / File(s) Summary
AI assistance disclosure prompt
.github/PULL_REQUEST_TEMPLATE.md
The template asks contributors to disclose AI use and scope, acknowledge the Contribution Gates, confirm authorship of review replies, and exclude trivial tab completion.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: chaunceyjiang

Poem

A rabbit updates the template with care,
AI guidance now waits there.
Gates are checked and replies are clear,
Small tab completions need no fear.
Ready paws prepare the contribution.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the addition of AI assistance disclosure to the pull request template.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@mesutoezdil mesutoezdil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@spencercjh

Copy link
Copy Markdown
Contributor

Agree with @mesutoezdil

Signed-off-by: AswaniSahoo <aswanisahoo1012@gmail.com>
@hami-robot hami-robot Bot added size/S and removed size/XS labels Aug 4, 2026
@AswaniSahoo
AswaniSahoo requested a review from mesutoezdil August 4, 2026 17:36
@AswaniSahoo

Copy link
Copy Markdown
Author

Pushed as 7f9c861.

Renamed the field to **AI assistance disclosure**: so a ci check can grep that exact string.

Pulled the "write None if you did not use any" line out of the html comment into visible text and linked the AI Assistance Notice. A blank field should read as unfilled now, not as no ai used.

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 None line into visible text, to keep the visible block short.
Happy to lift that too if you'd rather have both visible.

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unittests 61.03% <ø> (-3.20%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 28 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@archlitchi

Copy link
Copy Markdown
Member

/assign @mesutoezdil

@mesutoezdil

Copy link
Copy Markdown
Contributor

You can view the relevant rule here.
https://github.com/Project-HAMi/HAMi/blob/master/CONTRIBUTING.md#contribution-gates
"4. Review replies. The reply you post must be written by you and must address the specific point raised. Verbatim or canned AI replies, or replies that do not engage the comment, lead to the PR being closed."

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

Labels

dco-signoff: yes kind/documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants