Pull Request Enhancement
When to Use
- You need to turn a git diff into a reviewer-friendly pull request description.
- You want a PR summary with change categories, risks, testing notes, and a checklist.
- The diff is large enough that reviewers need explicit structure instead of a short ad hoc summary.
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
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
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## When to Use9- You need to turn a git diff into a reviewer-friendly pull request description.10- You want a PR summary with change categories, risks, testing notes, and a checklist.11- The diff is large enough that reviewers need explicit structure instead of a short ad hoc summary.1213## Workflow14151. Run `git diff <base>...HEAD --stat` to identify changed files and scope162. Categorise changes: source, test, config, docs, build, styles173. Generate the PR description using the template below184. Add a review checklist based on which file categories changed195. Flag breaking changes, security-sensitive files, or large diffs (>500 lines)2021## PR Description Template2223```markdown24## Summary25<!-- one-paragraph executive summary: what changed and why -->2627## Changes28| Category | Files | Key change |29|----------|-------|------------|30| source | `src/auth.ts` | added OAuth2 PKCE flow |31| test | `tests/auth.test.ts` | covers token refresh edge case |32| config | `.env.example` | new `OAUTH_CLIENT_ID` var |3334## Why35<!-- link to issue/ticket + one sentence on motivation -->3637## Testing38- [ ] unit tests pass (`npm test`)39- [ ] manual smoke test on staging40- [ ] no coverage regression4142## Risks & Rollback43- **Breaking?** yes / no44- **Rollback**: revert this commit; no migration needed45- **Risk level**: low / medium / high — because ___46```4748## Review Checklist Rules4950Add checklist sections only when the matching file category appears in the diff:5152| File category | Checklist items |53|---------------|----------------|54| source | no debug statements, functions <50 lines, descriptive names, error handling |55| test | meaningful assertions, edge cases, no flaky tests, AAA pattern |56| config | no hardcoded secrets, env vars documented, backwards compatible |57| docs | accurate, examples included, changelog updated |58| security-sensitive (`auth`, `crypto`, `token`, `password` in path) | input validation, no secrets in logs, authz correct |5960## Splitting Large PRs6162When diff exceeds 20 files or 1000 lines, suggest splitting by feature area:6364```65git checkout -b feature/part-166git cherry-pick <commits-for-part-1>67```6869## Resources7071- `resources/implementation-playbook.md` — Python helpers for automated PR analysis, coverage reports, and risk scoring7273## Limitations74- Use this skill only when the task clearly matches the scope described above.75- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.76- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
LiHongwei-cn