Repository navigation
docs: standardize PR delivery workflow #535
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| name: finish-pr | ||
| description: Use when a non-trivial code change is substantially complete and needs a final diff audit, documentation check, verification record, or pull request description. | ||
| --- | ||
|
|
||
| # Finish PR | ||
|
|
||
| Prepare reviewer-facing delivery from repository evidence. | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. Read `AGENTS.md`, `CLAUDE.md`, and `.github/pull_request_template.md`. | ||
| 2. Determine the PR base branch or repository default branch. Inspect `git status`, | ||
| commits since the merge base, the complete merge-base diff, and important files | ||
| in context. Include submodule pointer changes; do not treat only unstaged files | ||
| as the change. | ||
| 3. Audit comments in changed code. Add or update only comments that explain | ||
| non-obvious invariants, concurrency, ownership/lifetime, ordering, durability, | ||
| recovery/retry, performance, or compatibility. Do not narrate syntax. | ||
| 4. Run the relevant build, tests, formatting, and documentation checks from | ||
| `CLAUDE.md`. Record exact commands and outcomes. State checks not run. | ||
| 5. Fill the repository PR template from the final diff. | ||
|
|
||
| ## Quality gate | ||
|
|
||
| - Describe concrete behavior and named components; avoid “updated logic.” | ||
| - Explain material decisions and tradeoffs without inventing rejected designs. | ||
| - Cover compatibility, regression/operational risk, rollback, and the best review | ||
| entry points. | ||
| - Verify every claim against the final diff and current command output. | ||
| - Keep trivial changes concise; make non-trivial changes complete. | ||
| - Draft only unless the user explicitly asks to publish or update the PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| interface: | ||
| display_name: "Finish PR" | ||
| short_description: "Finalize changes for reviewer-ready delivery" | ||
| default_prompt: "Use $finish-pr to audit the final diff and prepare the pull request." |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| name: respond-to-review | ||
| description: Use when pull request review comments, requested changes, or reviewer questions need to be investigated, addressed, or answered. | ||
| --- | ||
|
|
||
| # Respond to Review | ||
|
|
||
| Resolve feedback against the current code and report exactly what changed. | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. Read repository instructions and collect every in-scope review comment with | ||
| its file, line, author, and thread status. | ||
| 2. Inspect the referenced code, callers, tests, and relevant diff before deciding | ||
| whether the feedback is valid. Do not implement comments blindly. | ||
| 3. Classify each item as accepted, already addressed, technically inapplicable, | ||
| or requiring user/product direction. Give evidence for disagreements. | ||
| 4. For accepted items, make the smallest root-cause fix, update necessary | ||
| explanatory comments/docs, and run focused regression checks plus required | ||
| repository checks. | ||
| 5. Re-read the final diff and draft a response that maps each review item to the | ||
| concrete change and verification result. Call out unresolved items and unrun | ||
| checks explicitly. | ||
|
|
||
| Do not resolve threads, post comments, push, or update a PR unless the user asks. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| interface: | ||
| display_name: "Respond to Review" | ||
| short_description: "Resolve feedback and report exact follow-up changes" | ||
| default_prompt: "Use $respond-to-review to address review feedback and draft the response." |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../.agents/skills/finish-pr |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../.agents/skills/respond-to-review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| ## Context | ||
|
|
||
| <!-- What problem does this solve, and why does it matter? --> | ||
|
|
||
| ## Behavior before and after | ||
|
|
||
| <!-- Describe observable behavior changes and compatibility implications. --> | ||
|
|
||
| ## Implementation | ||
|
|
||
| <!-- Explain the main control/data flow and the components changed. --> | ||
|
|
||
| ## Design decisions and alternatives | ||
|
|
||
| <!-- Why this approach? Note meaningful tradeoffs or rejected alternatives. --> | ||
|
|
||
| ## Test plan | ||
|
|
||
| - [ ] Unit/TCL tests | ||
| - [ ] Integration or manual validation | ||
| - [ ] Formatting/build checks | ||
| - [ ] Compatibility or performance validation, when relevant | ||
|
|
||
| Commands and results: | ||
|
|
||
| ```text | ||
| <!-- Paste exact commands and outcomes. State checks that were not run. --> | ||
| ``` | ||
|
|
||
| ## Risk assessment | ||
|
|
||
| <!-- Regression surface, failure modes, operational concerns, and gaps. --> | ||
|
|
||
| ## Rollback plan | ||
|
|
||
| <!-- Revert, configuration change, migration rollback, or "revert this PR". --> | ||
|
|
||
| ## Reviewer guide | ||
|
|
||
| <!-- Point reviewers to the highest-value files, functions, and invariants. --> | ||
|
|
||
| ## Follow-up work | ||
|
|
||
| <!-- Known limitations or deliberately deferred work. Use "None" if applicable. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Require
CLAUDE.mdto be read first.The workflow currently says “Read repository instructions” but does not enforce the repository’s required
CLAUDE.md-first order. Make this explicit before collecting or evaluating review feedback.Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents
Source: Coding guidelines