Cómo leer una revisión
HeyDeer publica sus hallazgos como una revisión de pull request de GitHub, con un comentario en línea en las líneas a las que se refiere cada hallazgo.
Qué publica HeyDeer
La revisión en GitHub no tiene resumen. El resumen y la lista completa de hallazgos están en La comprobación HeyDeer Review y en HeyDeer.
El comentario de revisión solo contiene las advertencias de la revisión, los hallazgos adicionales y, en su caso, el motivo de la aprobación. Una revisión sin nada que publicar no añade ningún comentario. Si la revisión es demasiado larga para GitHub, HeyDeer omite algunos hallazgos y añade un enlace Ver todos los hallazgos en HeyDeer.
HeyDeer solo aprueba un pull request cuando Aprobación automática está activada, y no repite un problema que la discusión ya planteó. Consulta Revisiones de seguimiento.
Con “Publicar comentarios de revisión en el PR” desactivado, solo la comprobación contiene la revisión. Consulta Publicación de resultados.
Cómo se estructura un hallazgo
| Parte | Qué muestra |
|---|---|
| Encabezado | Gravedad y título, por ejemplo HIGH: El bucle de reintentos nunca se detiene ante un 404. |
| Explicación | Cuál es el problema y qué provoca. |
| Corrección sugerida | Cómo corregirlo, explicado con palabras. |
| Cambio sugerido | Una edición exacta, como sugerencia de GitHub o como diff de solo lectura. |
| Comprobación | La comprobación del repositorio que lo planteó. |
| Código afectado | Un enlace a las líneas, cuando el comentario no está sobre ellas. |
La gravedad es Crítica, Alta, Media o Baja y refleja el impacto, con independencia de la confianza que tenga HeyDeer. Para publicar menos o más hallazgos, cambia el Alcance de los comentarios, que filtra por confianza.
Una sugerencia que puedes confirmar como commit solo aparece cuando el comentario está exactamente sobre las líneas que sustituye; en otros casos, el cambio es un diff de solo lectura. HeyDeer nunca ejecuta tu formateador ni tus tests, así que lee una sugerencia antes de hacer commit de ella.
GitHub solo acepta comentarios en línea en líneas del diff. Un hallazgo sobre otro código, como un llamador sin cambios que el cambio rompe, va en el comentario de revisión, en Hallazgos adicionales.
Advertencias de la revisión
Cuando algo limitó una revisión, el comentario de revisión, la comprobación y HeyDeer muestran Advertencias de la revisión.
| Advertencia | Qué hacer |
|---|---|
| Se omitieron hallazgos con menor grado de confianza | Una revisión conserva sus 30 hallazgos con mayor grado de confianza. Atiéndelos y luego solicita otra revisión. |
| Solo se seleccionaron las primeras 10 comprobaciones | Se aplican como máximo 10 comprobaciones del repositorio, por orden de nombre de archivo. Acota sus patrones de archivos. |
Este pull request cambia .agents/ y la nueva configuración de comprobaciones no es válida | Corrige la configuración antes de fusionar, o HeyDeer no podrá revisar pull requests para esa rama. |
| Algunos hallazgos o evaluaciones de hilos eran inválidos o estaban incompletos | Solicita otra revisión para obtener un resultado completo. |
Una revisión con una advertencia está incompleta: HeyDeer no la aprueba, su comprobación no informa de éxito y la siguiente revisión cubre todo el pull request.
Idioma de la revisión
El idioma de la revisión determina el idioma de los hallazgos, los resúmenes, las advertencias y las respuestas de HeyDeer en sus hilos. Elige inglés (el predeterminado), chino simplificado, japonés, español, coreano, portugués (Brasil) o alemán. El código y las rutas de archivo se mantienen tal cual.
Configúralo en Configuración de la organización → Reglas de revisión, en Cómo revisar, o en las Reglas de revisión de un repositorio.
La revisión en HeyDeer
Cada revisión tiene una página en HeyDeer. Ábrela desde Revisiones, desde el enlace Details de la comprobación o desde Ver todos los hallazgos en HeyDeer. Muestra qué desencadenó la revisión, si cubrió Cambios nuevos o el PR completo, los Créditos utilizados, todos los hallazgos dentro del alcance de los comentarios y las observaciones que aparecen en Descartadas en la discusión.
Vista previa del alcance de los comentarios muestra qué hallazgos conservaría cada alcance de los comentarios, sin cambiar nada. Alguien con acceso de escritura puede detener una revisión con Cancelar revisión; los créditos ya usados no se devuelven.