Nota:
GitHub Code Quality está actualmente en versión preliminar pública y sujeto a cambios. Durante versión preliminar pública, Code Quality no se facturará, aunque los escaneos de Code Quality consumirán minutos de GitHub Actions.
Introducción
En este tutorial se muestra cómo trabajar con GitHub Code Quality las solicitudes de incorporación de cambios para identificar los problemas de calidad del código que los cambios pueden introducir de forma involuntaria y cómo abordar y resolver los resultados de calidad del código con Autofix de Copilot y agente en la nube de Copilot.
Ventajas de detectar problemas al principio
Detectar problemas de calidad de código al principio mantiene el código base del equipo en forma. GitHub Code Quality comprueba tu código en busca de:
-
**Confiabilidad**: por ejemplo, errores lógicos, control de errores no seguros o condiciones de carrera que podrían provocar que la aplicación se bloquee o se comporte de forma impredecible. Al abordar este tipo de problema al principio, hace que el software sea más sólido y confiable para los usuarios. -
**Capacidad de mantenimiento**: por ejemplo, código duplicado, lógica excesivamente compleja, variables sin usar o infracciones de los procedimientos recomendados de codificación. Corregir estos problemas hace que el código sea más limpio y fácil de leer, por lo que los cambios futuros son más rápidos y menos arriesgados.
1. Comprender cómo GitHub Code Quality funciona en los pull requests
Al abrir una solicitud de incorporación de cambios, GitHub Code Quality usa CodeQL para examinar automáticamente los cambios en busca de problemas de calidad, como los descritos anteriormente.
Los resultados del CodeQL examen se informan como comentarios en tu pull request, dejados por el github-code-quality[bot]. Cada comentario corresponde a un problema de calidad del código específico que se detectó en los cambios realizados y viene con una autocorrección sugerida.
Los comentarios se etiquetan por gravedad (Error, Advertencia, Nota), por lo que puede ver qué hallazgos son los más críticos para abordar.
2. Priorizar correcciones en función de la gravedad
Examine los comentarios e identifique primero los resultados que tienen el nivel de gravedad más alto ("Error").
Si no hay ningún resultado de "Error", busque los resultados del siguiente nivel de gravedad ("Advertencia").
Los resultados de gravedad alta indican problemas de calidad de código más graves que son más probables para introducir problemas de confiabilidad o mantenimiento en el código base. Al resolver hallazgos de alta gravedad, estás realizando el trabajo que tiene mayor impacto para mantener la calidad del código de tu equipo.
Nota:
Un administrador del repositorio puede haber establecido una puerta de calidad de código que bloquee la combinación en la solicitud de incorporación de cambios, si la solicitud de incorporación de cambios contiene Code Quality resultados de un nivel de gravedad determinado o superior. Consulta Resolución de un bloqueo en la solicitud de extracción.
3. Utilizar Autofix de Copilot o agente en la nube de Copilot para corregir los hallazgos
Autofix de Copilot
Los comentarios de la solicitud de incorporación de cambios incluyen un autofix sugerido que puede confirmar directamente en su solicitud. Revise cuidadosamente la corrección automática sugerida en cuanto a lógica, seguridad y estilo, luego haga clic en Confirmar sugerencia.
No necesita una licencia Copilot para aplicar estas sugerencias.
agente en la nube de Copilot
Como alternativa, si tiene una Copilot licencia, puede delegar el trabajo de corrección en agente en la nube de Copilot. Haga un comentario en la solicitud de incorporación de cambios mencionando @Copilot y solicite que Copilot corrija los problemas detectados.
Copilot responde con un emoji de ojos (👀) a tu comentario, inicia una nueva sesión del agente y abre un pull request con las correcciones necesarias.
Puede hacer seguimiento del trabajo de agente en la nube de Copilot.
- En el pull request, el resumen se actualiza conforme avanza el trabajo.
- Utilizando la página de agentes o los registros de sesión: consulte Seguimiento de las sesiones de GitHub Copilot.
Necesita una Copilot licencia para invocar agente en la nube de Copilot.
Regístrese para Copilot
4. Descartar conclusiones irrelevantes
Puede descartar una búsqueda si no es relevante o procesable en el contexto de su código base. Entre las razones comunes para descartar un hallazgo se incluyen:
- El hallazgo está en el código heredado que ya no se mantiene.
- Es una excepción conocida a los estándares de codificación de su equipo.
- Es un falso positivo que no supone un riesgo real de calidad.
Descartar alertas irrelevantes mantiene las comprobaciones de calidad centradas en problemas significativos.
5. Enviar cambios y esperar el escaneo
Después de corregir o descartar los resultados, suba sus cambios a la rama asociada con su pull request. GitHub Code Quality volverá a examinar automáticamente los cambios y actualizará los comentarios de la solicitud de incorporación de cambios según corresponda.
6. Compruebe las clasificaciones de calidad del código del repositorio.
Cualquier persona con acceso de escritura puede ver las clasificaciones generales de calidad del código de un repositorio, que resumen el estado de confiabilidad y mantenimiento del código en la rama predeterminada.
Para ver las clasificaciones del repositorio, vaya a la Security and quality pestaña del repositorio, expanda Calidad del código en la barra lateral y haga clic en Conclusiones estándar.
Al resolver problemas antes de combinar la solicitud de incorporación de cambios, contribuye directamente a mantener estas clasificaciones.
Pasos siguientes
- Solucione los resultados de calidad del código en la rama predeterminada y comprenda las clasificaciones de confiabilidad y mantenimiento del repositorio. Consulta Mejora de la calidad del código del repositorio.
- Proporcione comentarios sobre GitHub Code Quality en la discusión de la comunidad.