farhoodlabs/trebuchet
8
0
Fork 0
Code Issues Pull Requests 5 Actions Packages Projects Releases Wiki Activity

chore: improve PR command summary format with rich bullet style

Browse Source
This commit is contained in:
ajmallesh
2026-02-24 09:31:37 -08:00
parent d67c07dc55
commit a03bc7506c
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.claude/commands/pr.md
+16 -3
View File
@@ -26,14 +26,28 @@ Then generate a PR title that:
- Matches the style of recent commits in the repository - Matches the style of recent commits in the repository
Generate a PR body with: Generate a PR body with:
- A `## Summary` section with 1-3 bullet points describing the changes - A `## Summary` section using rich bullets with bold action leads
- A `Closes #X` line for each issue number (if any were provided or detected from branch name) - A `Closes #X` line for each issue number (if any were provided or detected from branch name)
Each Summary bullet must follow this format:
- **Bold action phrase** (imperative verb: "Add X", "Replace Y", "Fix Z") — followed by em dash and a 1-2 sentence conceptual description of what changed and why
- Keep descriptions conceptual — no inline code references (no backticks for function/file names). The diff shows the code
- Use 2-5 bullets, scaling with PR size. Group related changes into single bullets rather than listing every file touched
Example:
```
## Summary
- **Add preflight validation** — validates repo path, config, and credentials before agent execution. Fails fast with actionable errors
- **Replace error strings** — pipe-delimited segments rendered as multi-line blocks with phase context, type, message, and remediation hint
- **Add error classification** — new error codes for repo, auth, and billing failures with proper retry classification
```
Finally, create the PR using the gh CLI: Finally, create the PR using the gh CLI:
``` ```
gh pr create --base main --title "<generated title>" --body "$(cat <<'EOF' gh pr create --base main --title "<generated title>" --body "$(cat <<'EOF'
## Summary ## Summary
<bullet points> <rich bullets>
Closes #<issue1> Closes #<issue1>
Closes #<issue2> Closes #<issue2>
@@ -45,6 +59,5 @@ Note: Omit the "Closes" lines entirely if no issues are associated with this PR.
IMPORTANT: IMPORTANT:
- Do NOT include any Claude Code attribution in the PR - Do NOT include any Claude Code attribution in the PR
- Keep the summary concise (1-3 bullet points maximum)
- Use the conventional commit prefix that best matches the changes (fix, feat, chore, refactor, docs, etc.) - Use the conventional commit prefix that best matches the changes (fix, feat, chore, refactor, docs, etc.)
- The `Closes #X` syntax will automatically close the referenced issues when the PR is merged - The `Closes #X` syntax will automatically close the referenced issues when the PR is merged