Introducción
GitHub Code Quality (versión preliminar pública) ayuda a mantener el código fiable y fácil de mantener al mostrar los resultados de calidad del código en las solicitudes de incorporación de cambios y en la rama predeterminada.
En este tutorial, aprenderás a identificar y corregir un problema de calidad de código en la rama predeterminada, ayudando a mejorar la salud del código de tu repositorio.
Prerrequisitos
- GitHub Code Quality debe estar habilitado para su repositorio y usted debe tener el código en un idioma compatible. Consulta Habilitación de GitHub Code Quality.
- Si está habilitando GitHub Code Quality por primera vez, asegúrese de haber esperado unos minutos después de la habilitación para que se complete un análisis completo de CodeQL de la rama predeterminada.
Revisión de los resultados de escaneo de la rama predeterminada
En el repositorio, vaya a la pestaña Seguridad , haga clic en Calidad del código en la barra lateral izquierda y, a continuación, haga clic en Conclusiones estándar para abrir el panel del repositorio.
Aquí verá lo siguiente:
-
Clasificaciones para la confiabilidad y el mantenimiento de su código base, lo que le ayuda a comprender el estado del código de un vistazo.
-
Una lista de resultados de todos los problemas de calidad detectados por un análisis impulsado por CodeQL en la rama predeterminada, que se agrupan por regla y idioma.
Identificar un hallazgo de alto impacto
Utilice los filtros del panel para identificar un hallazgo de alto nivel de gravedad ("Error" o "Advertencia").
La resolución de estos tendrá el mayor impacto en las clasificaciones del repositorio.
Inspecciona los detalles del hallazgo
Haga clic en el propio nombre de la regla para ver una vista detallada de los archivos y líneas de código afectados por esa regla.
Una vez que esté en la vista detallada, haga clic en Mostrar más para recopilar contexto y comprender los resultados.
Generar un Corrección automática de Copilot
A la derecha de un resultado resaltado, haga clic en Generar corrección.
Revise la corrección sugerida y haga clic en Abrir solicitud de incorporación de cambios.
Combinar la corrección
Revise cuidadosamente el borrador de solicitud de cambios. Si está satisfecho con los cambios propuestos y han pasado todas las comprobaciones y pruebas, proceda a combinar el pull request.
Observar el cambio de métricas
Vuelva al panel Code Quality (pestaña Seguridad, luego Calidad del código y, a continuación, Conclusiones estándar).
Espere unos minutos para que se complete el siguiente análisis, los análisis de Code Quality se vuelven a ejecutar automáticamente después de cada inserción a la rama predeterminada.
Observe el cambio en las métricas en la parte superior del panel:
-
El número de hallazgos de "Confiabilidad" o "Capacidad de mantenimiento" debe haber disminuido.
-
Es posible que las clasificaciones de "Confiabilidad" o "Mantenimiento" hayan mejorado, si la corrección ha solucionado una serie de hallazgos de alto impacto.
Para obtener más información sobre cómo se calculan las clasificaciones, consulte Referencia de métricas y clasificaciones.
Conclusión
Ha utilizado correctamente Code Quality and Corrección automática de Copilot para mejorar el estado del código de su repositorio.
El código correcto es más fácil de comprender, mantener y ampliar y corregir los problemas de calidad del código hace que el código base sea más confiable, compatible y acelere el desarrollo futuro.
Pasos siguientes
- Obtenga información sobre cómo GitHub Code Quality funciona en las solicitudes de incorporación de cambios para evitar que los problemas de calidad del código lleguen a la rama predeterminada. Consulta Corrección de los resultados de calidad de código antes de combinar el pull request.
- Proporcione comentarios sobre GitHub Code Quality en la discusión de la comunidad.