Cómo leer una revisión
Descubre qué significa cada parte de una revisión de HeyDeer, en GitHub y en HeyDeer.
Qué publica HeyDeer
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.
El cuerpo de la revisión empieza con el resultado y enlaza los problemas anteriores que aún requieren atención. Termina con una sección contraída Acerca de esta revisión: el resumen de la revisión, el nivel de riesgo, la Profundidad de revisión, el Origen y los enlaces Ver en HeyDeer y Configuración.
El cuerpo también contiene las notas de la revisión, las preguntas de Requiere aclaración y los hallazgos que no pueden ir en línea. GitHub solo acepta comentarios en línea en líneas del diff, así que un hallazgo sobre otro código, como una llamada no modificada que el cambio rompe, aparece en Hallazgos adicionales.
El informe completo está en La comprobación HeyDeer Review y en la página de la revisión en HeyDeer. Si una revisión es demasiado larga para un solo comentario de GitHub, el informe completo conserva el resto.
HeyDeer solo aprueba un pull request cuando Aprobación automática está activada.
Con Publicar comentarios de revisión en el PR desactivado, solo la comprobación contiene la revisión. Consulta Publicar resultados.
HeyDeer escribe todo lo que publica en el Idioma de la revisión del repositorio.
Cómo se estructura un hallazgo
| Parte | Qué muestra |
|---|---|
| Encabezado | Gravedad, categoría y título, por ejemplo 🟠 Alta (Fiabilidad): El bucle de reintentos nunca se detiene ante un 404. |
| Explicación | Qué está mal y qué provoca. |
| Cambio sugerido | Una edición exacta que puedes confirmar, cuando el comentario está en las líneas que reemplaza. |
| Más información | Contraído: por qué ocurre, la corrección sugerida, un diff de solo lectura de un cambio que no se puede confirmar aquí y la comprobación del repositorio que lo detectó. |
| Código afectado | Un enlace a las líneas, cuando el comentario no está sobre ellas. |
La gravedad (Crítica, Alta, Media o Baja) es el impacto del hallazgo. Es independiente de la confianza, que es lo seguro que está HeyDeer de que el hallazgo es real. Para publicar menos o más hallazgos, cambia el Alcance de los comentarios, que combina ambas.
Para que HeyDeer haga los cambios en un PR independiente que puedas revisar y fusionar, usa Corregir con HeyDeer.
Categorías
La categoría es lo que perjudica el hallazgo, independiente de su gravedad. Si encajan varias, HeyDeer elige la primera de esta tabla.
| Categoría | Qué perjudica |
|---|---|
| Seguridad | Alguien puede hacer o ver lo que no debería. |
| Corrección | El código da un resultado incorrecto en el uso normal. |
| Fiabilidad | El código falla ante errores, concurrencia, carga, reintentos o fallos parciales. |
| Rendimiento | El código consume demasiado tiempo o demasiados recursos. |
| Mantenibilidad | Nada falla, pero el código es más difícil de cambiar, probar o leer. |
Notas de la revisión
Cuando algo limitó una revisión, HeyDeer lo explica en Notas de la revisión en el cuerpo de la revisión, en el resumen de la comprobación y en la página de la revisión.
| Nota de la revisión | Qué hacer |
|---|---|
| Se omitieron algunos hallazgos | Una revisión conserva solo los hallazgos de mayor prioridad según la confianza y la gravedad. Corrige o descarta los hallazgos mostrados y solicita otra revisión. |
| Coincidieron demasiadas comprobaciones del repositorio | HeyDeer aplica las comprobaciones coincidentes por orden de nombre de archivo y omite las demás. Acota sus patrones de archivos y solicita otra revisión. |
| Algunas comprobaciones del repositorio no son válidas | HeyDeer omite la comprobación no válida y la indica. Corrígela y solicita otra revisión. |
| No se pudieron completar algunas comprobaciones del repositorio | Solicita otra revisión. |
| No se pudieron evaluar por completo algunos hallazgos o problemas anteriores | Solicita otra revisión para obtener un resultado completo. |
Una revisión con notas de la revisión está incompleta, así que HeyDeer no la aprueba y su comprobación no informa de éxito.
Para obtener más ayuda con las notas de la revisión, consulta Solución de problemas.
Recorrido
Una revisión en GitHub tiene un botón Recorrido junto a Corregir con HeyDeer. Abre el recorrido en HeyDeer, con los cambios relacionados agrupados y los cambios importantes destacados. Cada grupo dice qué comprobar y muestra ese código tal como está en el commit revisado.
Los grupos relacionados comparten una pestaña. Una pestaña cuyos cambios abarcan varias partes del sistema, como el navegador, un servidor y una base de datos, empieza con un diagrama: cómo se conectan esas partes o los pasos entre ellas en orden. Selecciona el diagrama para ampliarlo.
Los grupos se marcan como Lectura obligatoria, Lectura recomendada o Vistazo. Los cambios fuera del camino principal, como pruebas, documentación y ediciones repetidas, aparecen en Otros con el motivo. Los archivos generados que la revisión omitió aparecen al final de Otros, y una revisión posterior del mismo PR marca los grupos que cambiaron desde la última revisión.
El recorrido explica el cambio; no es una lista de hallazgos. La página de la revisión en HeyDeer también lo abre con Recorrido. Desactívalo con Recorrido en las reglas de revisión.
Marca Visto en un archivo para plegarlo. Cuando todas las partes del archivo están marcadas, HeyDeer también marca el archivo como visto en GitHub, y GitHub borra esa marca cuando el archivo cambia.
La revisión en HeyDeer
Cada revisión tiene una página en HeyDeer. Ábrela desde Historial de revisiones, desde el enlace Details de la comprobación o desde Ver en HeyDeer en el cuerpo de la revisión.
La página de la revisión muestra el Origen y si cubrió Cambios nuevos o el PR completo. También enumera todos los hallazgos dentro del alcance de los comentarios y los problemas de Descartados en la discusión.
Mientras se ejecuta una revisión, Progreso de la revisión muestra sus etapas y lo que está haciendo cada revisor. Cuando termina, el panel contraído Actividad de la revisión conserva cada etapa, cuánto duró la revisión y lo que hizo cada revisor.
Cuando otro alcance de los comentarios conservaría hallazgos distintos, puedes verlo en vista previa sin cambiar nada: elige el alcance junto a Hallazgos o selecciona Vista previa bajo un resultado sin hallazgos. Alguien con acceso de escritura puede detener una revisión con Cancelar revisión; los créditos ya usados no se devuelven.