Pull Request Enhancement
Workflow
- Run
git diff <base>...HEAD --stat to identify changed files and scope
- Categorise changes: source, test, config, docs, build, styles
- Generate the PR description using the template below
- Add a review checklist based on which file categories changed
- Flag breaking changes, security-sensitive files, or large diffs (>500 lines)
PR Description Template
## Summary
<!-- one-paragraph executive summary: what changed and why -->
## Changes
| Category | Files | Key change |
|----------|-------|------------|
| source | `src/auth.ts` | added OAuth2 PKCE flow |
| test | `tests/auth.test.ts` | covers token refresh edge case |
| config | `.env.example` | new `OAUTH_CLIENT_ID` var |
## Why
<!-- link to issue/ticket + one sentence on motivation -->
## Testing
- [ ] unit tests pass (`npm test`)
- [ ] manual smoke test on staging
- [ ] no coverage regression
## Risks & Rollback
- **Breaking?** yes / no
- **Rollback**: revert this commit; no migration needed
- **Risk level**: low / medium / high — because ___
Review Checklist Rules
Add checklist sections only when the matching file category appears in the diff:
| File category |
Checklist items |
| source |
no debug statements, functions <50 lines, descriptive names, error handling |
| test |
meaningful assertions, edge cases, no flaky tests, AAA pattern |
| config |
no hardcoded secrets, env vars documented, backwards compatible |
| docs |
accurate, examples included, changelog updated |
security-sensitive (auth, crypto, token, password in path) |
input validation, no secrets in logs, authz correct |
Splitting Large PRs
When diff exceeds 20 files or 1000 lines, suggest splitting by feature area:
git checkout -b feature/part-1
git cherry-pick <commits-for-part-1>
Resources
resources/implementation-playbook.md — Python helpers for automated PR analysis, coverage reports, and risk scoring
1---2name: comprehensive-review-pr-enhance3description: Generate structured PR descriptions from diffs, add review checklists, risk assessments, and test coverage summaries. Use when the user says "write a PR description", "improve this PR", "summarize my changes", "PR review", "pull request", or asks to document a diff for reviewers.4---56# Pull Request Enhancement78## Workflow9101. Run `git diff <base>...HEAD --stat` to identify changed files and scope112. Categorise changes: source, test, config, docs, build, styles123. Generate the PR description using the template below134. Add a review checklist based on which file categories changed145. Flag breaking changes, security-sensitive files, or large diffs (>500 lines)1516## PR Description Template1718```markdown19## Summary20<!-- one-paragraph executive summary: what changed and why -->2122## Changes23| Category | Files | Key change |24|----------|-------|------------|25| source | `src/auth.ts` | added OAuth2 PKCE flow |26| test | `tests/auth.test.ts` | covers token refresh edge case |27| config | `.env.example` | new `OAUTH_CLIENT_ID` var |2829## Why30<!-- link to issue/ticket + one sentence on motivation -->3132## Testing33- [ ] unit tests pass (`npm test`)34- [ ] manual smoke test on staging35- [ ] no coverage regression3637## Risks & Rollback38- **Breaking?** yes / no39- **Rollback**: revert this commit; no migration needed40- **Risk level**: low / medium / high — because ___41```4243## Review Checklist Rules4445Add checklist sections only when the matching file category appears in the diff:4647| File category | Checklist items |48|---------------|----------------|49| source | no debug statements, functions <50 lines, descriptive names, error handling |50| test | meaningful assertions, edge cases, no flaky tests, AAA pattern |51| config | no hardcoded secrets, env vars documented, backwards compatible |52| docs | accurate, examples included, changelog updated |53| security-sensitive (`auth`, `crypto`, `token`, `password` in path) | input validation, no secrets in logs, authz correct |5455## Splitting Large PRs5657When diff exceeds 20 files or 1000 lines, suggest splitting by feature area:5859```60git checkout -b feature/part-161git cherry-pick <commits-for-part-1>62```6364## Resources6566- `resources/implementation-playbook.md` — Python helpers for automated PR analysis, coverage reports, and risk scoring
eszxcvfd