Skip to content

docs: clarify PR completion invariant #7339

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
bokelley wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify PR completion invariant #7339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions .agents/playbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,13 @@ Before creating or updating a PR, always:
3. **Check for XSS patterns** — any `innerHTML`, `contenteditable`, or template string interpolation of user data gets flagged. Use `textContent` or escape functions.
4. **Avoid polynomial regexes on user input** — simple string checks (`.includes()`, `.startsWith()`) are safer and faster than regex for validation.
5. **Run `gh pr checks {PR_NUMBER}`** to verify all CI passes before requesting review.
6. **Apply the completion invariant before declaring the task/PR done or
merging** — no review comment, inline comment, conversation thread,
requested change, CodeQL/security annotation, or required check may remain
open. Respond where appropriate, implement or explicitly resolve every
item, and re-request review after material changes. Verify the exact final
head has no unresolved threads or comments and that every required check is
green. Never silently dismiss comments merely to make the count zero.

## Triage Routine — Manual Nudge

Expand Down
5 changes: 5 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
This file is a thin wrapper. The canonical shared behavior for this repository
lives in `.agents/playbook.md`.

## Completion invariant

Do not declare work done or merge a PR until its comments, review threads, and
required checks meet the canonical completion rule in `.agents/playbook.md`.

## Start Here

1. Read `.agents/playbook.md`.
Expand Down
Loading