Skip to content

docs: disclose human review status in pull requests #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zywind wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: disclose human review status in pull requests #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
520fdd5
docs: disclose human review status in pull requests
zywind Aug 12, 2026
1389fec
docs: improve human review status selection
zywind Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@
# Summary
<!-- Brief description of changes -->

## Human review

Select exactly one. The default is no human review; uncheck it when choosing another level.

- [x] ⚪ No human review; automated review only
- [ ] 🟡 Partially reviewed or spot-checked by a human
- [ ] 🔵 Complete diff reviewed by a human
- [ ] 🟢 Complete diff reviewed and verified by a human

Verification performed:

@coderabbitai coderabbitai Bot Aug 12, 2026

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.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

Make the verification field explicit for the verified status.

If a contributor selects Complete diff reviewed and verified by a human, the template does not state that Verification performed: is required or what to enter when no verification occurred. This permits a verified status with no supporting record. Add a short condition for this field.

Proposed wording 
-Verification performed:
+Verification performed (required for the verified option; write `None` otherwise):
📝 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
Verification performed:
Verification performed (required for the verified option; write `None` otherwise):


## Pre-Review Checklist

<!-- These checks should be completed before a PR is reviewed, -->
Expand Down
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Feature branches off `main`. Branch names often include an issue number prefix (

Do not commit unless the user asks for a commit or PR work. When committing, all commits require DCO sign-off and GPG signing. Always use `git commit --signoff --gpg-sign` (or `-s -S`) -- never write the `Signed-off-by` trailer manually, and never pass `--no-gpg-sign`.

When creating or updating a pull request, complete the Human review section in `.github/PULL_REQUEST_TEMPLATE.md` accurately. Keep its default checkbox unless a human explicitly confirms a higher review level; then select exactly that level and report only review or verification the human confirmed.

Shell scripting: never use `~` inside double-quoted strings -- it does not expand. Use `$HOME` or an absolute path instead.

Testing gotchas: `asyncio_mode = auto` in `pytest.ini` -- async tests work without `@pytest.mark.asyncio`. The `unit_test` marker is deprecated; use `unit`.
Expand Down
Loading