协作头脑风暴
brainstorming
在实现前澄清需求、探索设计选择,并形成清晰的开发方向。
review-pull-request【开发与工程】Revisar una pull request de principio a fin usando GitHub CLI. Cubre el análisis del diff, la revisión del historial de commits, la verificación de comprobaciones CI/CD, la retroalimentación con niveles de gravedad (bloqueante/sugerencia/detalle/elogio) y el envío con gh pr review. Usar cuando se asigne una pull request para revisión, al realizar una…
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
Revisar una pull request de GitHub de principio a fin — desde comprender el cambio hasta enviar retroalimentación estructurada. Usa el CLI gh para todas las interacciones con GitHub y produce comentarios de revisión con niveles de gravedad.
owner/repo#number)Leer la descripción de la PR y entender qué trata de lograr el cambio.
gh pr view <number> --json title,body,author,baseRefName,headRefName,labels,additions,deletions,changedFiles,reviewDecision
Guía de Tamaño de PR:
+----------+-----------+---------+---------------------------------------+
| Tamaño | Archivos | Líneas | Enfoque de Revisión |
+----------+-----------+---------+---------------------------------------+
| Pequeño | 1-5 | <100 | Leer cada línea, revisión rápida |
| Mediano | 5-15 | 100-500 | Enfocarse en cambios lógicos, revisar |
| | | | superficialmente la configuración |
| Grande | 15-30 | 500- | Revisar por commit, centrarse en |
| | | 1000 | archivos críticos, señalar si debe |
| | | | dividirse |
| XL | 30+ | 1000+ | Señalar para división. Revisar solo |
| | | | los archivos más críticos. |
+----------+-----------+---------+---------------------------------------+
gh pr view <number> --json commits --jq '.commits[].messageHeadline'
gh pr checks <number>
Esperado: Una comprensión clara de qué hace la PR, por qué existe, qué tamaño tiene y si CI está en verde. Este contexto da forma al enfoque de revisión.
En caso de fallo: Si la descripción de la PR está vacía o es poco clara, anote esto como la primera retroalimentación. Una PR sin contexto es un antipatrón de revisión. Si los comandos gh fallan, verifique que está autenticado (gh auth status) y tiene acceso al repositorio.
Leer los cambios de código reales de manera sistemática.
gh pr diff <number>
gh pr diff <number> --patch # full patch format
Esperado: Un conjunto de observaciones que cubra la corrección, seguridad, rendimiento y calidad para cada cambio significativo en el diff. Cada observación tiene un nivel de gravedad.
En caso de fallo: Si el diff es demasiado grande para revisarlo eficazmente, señálelo: "Esta PR modifica {N} archivos y {M} líneas. Recomiendo dividirla en PRs más pequeñas para una revisión más efectiva." De todos modos, revise los archivos de mayor riesgo.
Organizar las observaciones en niveles de gravedad.
Niveles de Gravedad de Retroalimentación:
+-----------+------+----------------------------------------------------+
| Nivel | Icono| Descripción |
+-----------+------+----------------------------------------------------+
| Bloqueante| [B] | Debe corregirse antes de fusionar. Errores, |
| | | problemas de seguridad, riesgos de pérdida de |
| | | datos, funcionalidad rota. |
| Sugerencia| [S] | Debería corregirse, pero no bloqueará la fusión. |
| | | Mejores enfoques, casos extremos faltantes, |
| | | problemas de estilo que afectan la mantenibilidad. |
| Detalle | [N] | Mejora opcional. Preferencias de estilo, |
| | | sugerencias menores de nomenclatura, formato. |
| Elogio | [P] | Buen trabajo que merece mención. Soluciones |
| | | inteligentes, pruebas exhaustivas, abstracciones |
| | | limpias. |
+-----------+------+----------------------------------------------------+
Esperado: Una lista ordenada de elementos de retroalimentación con niveles de gravedad claros. Los elementos Bloqueantes tienen sugerencias de corrección. La proporción debería ser generalmente: pocos Bloqueantes, algunos Sugerencia, mínimos Detalles, al menos un Elogio.
En caso de fallo: Si todo parece bloqueante, puede que la PR necesite rehacerse en lugar de parchearse. Considere solicitar cambios a nivel de PR en lugar de comentarios línea por línea. Si nada parece incorrecto, dígalo — "LGTM" es una retroalimentación válida cuando el código es bueno.
Componer la revisión con retroalimentación estructurada y accionable.
# Post inline comments via gh API
gh api repos/{owner}/{repo}/pulls/{number}/comments \
-f body="[B] This SQL query is vulnerable to injection. Use parameterized queries instead.\n\n\`\`\`suggestion\ndb.query('SELECT * FROM users WHERE id = $1', [userId])\n\`\`\`" \
-f commit_id="<sha>" \
-f path="src/users.js" \
-F line=42 \
-f side="RIGHT"
[B], [S], [N] o [P]# Approve
gh pr review <number> --approve --body "Review summary here"
# Request changes (when blocking issues exist)
gh pr review <number> --request-changes --body "Review summary here"
# Comment only (when unsure or providing FYI feedback)
gh pr review <number> --comment --body "Review summary here"
Esperado: Una revisión enviada con retroalimentación clara y accionable. El autor sabe exactamente qué corregir (Bloqueante), qué considerar (Sugerencia) y qué salió bien (Elogio).
En caso de fallo: Si gh pr review falla, verifique los permisos. Necesita acceso de escritura al repositorio o ser un revisor solicitado. Si los comentarios en línea fallan, ponga toda la retroalimentación en el cuerpo de la revisión con referencias a archivo:línea.
Rastrear la resolución de la revisión.
gh pr view <number> --json reviewDecision,reviews
gh pr diff <number> # check new commits
gh pr review <number> --approve --body "All blocking issues resolved. LGTM."
Esperado: Los problemas Bloqueantes verificados como corregidos. Conversación de revisión resuelta. PR aprobada o se solicitan más cambios con elementos restantes específicos.
En caso de fallo: Si el autor no está de acuerdo con la retroalimentación, discuta en el hilo de la PR. Enfóquese en el impacto (por qué importa) en lugar de la autoridad. Si el desacuerdo persiste en elementos no bloqueantes, ceda con gracia — el autor es dueño del código.
review-software-architecture — revisión de arquitectura a nivel de sistema (complementaria a la revisión a nivel de PR)security-audit-codebase — análisis de seguridad profundo para PRs con cambios sensibles a la seguridadcreate-pull-request — el otro lado del proceso: crear PRs fáciles de revisarcommit-changes — un historial de commits limpio facilita significativamente la revisión de PRs