REVIEW.md
Pon en REVIEW.md las pautas que solo importan en la revisión de código: qué comprobar, qué dejar tal cual y qué gravedad tiene un problema. Otras herramientas de revisión de código, como Claude Code Review, leen el mismo archivo, así que puedes conservar el tuyo.
Qué escribir
- Qué comprobar en cada pull request, como el alcance de las consultas a la base de datos.
- Qué dejar tal cual, como los problemas que tu CI ya notifica. Mantén las exclusiones concretas e indica las rutas a las que se aplican.
- Qué gravedad tiene un tipo de problema para tu equipo, con las gravedades de HeyDeer: Crítica, Alta, Media y Baja.
REVIEW.md
# Review instructions
## Always check
- Database queries in src/api/ are scoped to the caller's
workspace.
- Log lines don't include email addresses or request bodies.
## Leave alone
- Formatting and lint issues. CI enforces them.
- Code in tests/fixtures/ that breaks production rules on purpose.
## Severity
- A migration that isn't backward compatible is High.
- Naming and refactoring suggestions are Low.Pon las convenciones de código en AGENTS.md, para que los agentes de programación también las sigan. Si HeyDeer debe verificar un requisito en cada pull request al que se aplique, ponlo en una comprobación del repositorio.
Archivos en la raíz y anidados
Añade REVIEW.md a la raíz del repositorio. Un directorio que necesite sus propias pautas puede tener su propio archivo, como src/payments/REVIEW.md.
Un REVIEW.md se aplica a los cambios de su directorio y sus subdirectorios. Un archivo más profundo se suma a los superiores y prevalece cuando se contradicen.
| Archivo modificado | Archivos que se aplican, en orden |
|---|---|
src/api/invoices.ts | REVIEW.md |
src/payments/refund.ts | REVIEW.md, src/payments/REVIEW.md |
Lo que decide la configuración
REVIEW.md cambia lo que busca HeyDeer y la gravedad de un problema, no cómo informa HeyDeer. Para eso, usa la configuración: Idioma de la revisión, Alcance de los comentarios y Aprobación automática. Por ejemplo, para publicar menos hallazgos de gravedad Baja, elige el alcance Conciso.
REVIEW.md no se aplica a las comprobaciones del repositorio: una comprobación aplicable siempre se ejecuta, y solo ella decide qué la incumple.
Para omitir los archivos generados, márcalos en .gitattributes, así quedan fuera de la revisión. Consulta Archivos generados.
Pull requests que modifican REVIEW.md
HeyDeer lee REVIEW.md del pull request, así que un pull request que lo modifica se revisa con su propia versión, y HeyDeer nunca lo aprueba automáticamente. Pon en las instrucciones de revisión las pautas que un pull request no debe poder cambiar.
Si vienes de Claude Code Review
Tu REVIEW.md funciona tal cual. Quedan estas diferencias:
- HeyDeer lee REVIEW.md del pull request, mientras que Claude Code Review lo lee de la rama base.
- Important corresponde a gravedad Media o superior, y Nit a Baja.
- No se aplica ningún límite al número de Nits. Elige en su lugar el alcance Conciso.
- HeyDeer no sigue inclusiones como
@review-security.md. Mueve sus pautas a REVIEW.md.