Skip to content

fix(prompts): avoid redundant PR description updates #3

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

Merged
Mearman merged 1 commit into from
Feb 13, 2026
Merged

fix(prompts): avoid redundant PR description updates #3

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
16 changes: 9 additions & 7 deletions .github/prompts/shared/02-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,26 @@ click "Apply" on all of them. Keep subsequent comments brief.

After submitting a review, do both of the following:

1. **Update the PR description** (the body of the PR itself, NOT a comment)
with a concise summary of what the PR changes and why. Describe the actual
modifications (new files, refactored logic, bug fixes), not the review
status.
1. **Update the PR description** ONLY if it's missing or incomplete. First check
the existing description with `gh pr view $PR_NUMBER`. If it already has a
clear summary of changes, skip this step entirely.

When updating, add only what's missing. Use headings only when organizing
multiple distinct sections — a single paragraph needs no `## Summary` heading
since the marker block already provides context.

```bash
gh pr edit $PR_NUMBER --body "$(cat <<'EOF'
<!-- claude:start -->
## Summary
<brief description of changes>
<only add information not already present in the description>
<!-- claude:end -->
EOF
)"
```

The markers `<!-- claude:start -->` / `<!-- claude:end -->` identify your
section. Preserve everything outside the markers. If no marker block exists,
append yours at the end.
append yours at the end. Do NOT repeat information already in the PR body.

2. **Update PR labels** to reflect the outcome:
- `gh pr edit {pr} --add-label "needs-changes"` after REQUEST_CHANGES
Expand Down