Receber por email
← Voltar para o catálogo

comprehensive-review-pr-enhance

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.

141estrelas
Atualizado há 4 meses

Ver no GitHub ↗ Licença: MIT

Como adicionar

/plugin marketplace add lingxling/awesome-skills-cn

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/comprehensive-review-pr-enhance/svg)](https://www.skillteca.com.br/skills/comprehensive-review-pr-enhance)

Alerta por categoria

Receba novas skills de Design e Frontend toda segunda

1 email curto, só com as skills novas de Design e Frontend. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

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

  1. Run git diff <base>...HEAD --stat to identify changed files and scope
  2. Categorise changes: source, test, config, docs, build, styles
  3. Generate the PR description using the template below
  4. Add a review checklist based on which file categories changed
  5. 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.
Compartilhar X LinkedIn