Skip to main content

Corregir los hallazgos de calidad del código en la lista de tareas pendientes del repositorio

Generar correcciones automáticas para los hallazgos de la rama por defecto del repositorio, o descartar los hallazgos que no sean pertinentes.

¿Quién puede utilizar esta característica?

Usuarios con acceso de escritura

GitHub Team o GitHub Enterprise Cloud

Sugerencia

Si no está familiarizado con Code Quality, consulte Aumentar la puntuación de calidad del código de su repositorio para ver un tutorial guiado sobre cómo revisar y mejorar las puntuaciones de calidad del repositorio.

Cómo funciona Code Quality en tu rama predeterminada

Code Quality examina tu rama predeterminada y muestra los hallazgos en las páginas "Calidad del código" de la pestaña Security and quality de tu repositorio. Ejecuta dos tipos de análisis.

  1. ** Conclusiones estándar **: Code Quality usa CodeQL para realizar un examen determinista basado en reglas de la rama predeterminada. Los hallazgos se agrupan por regla e idioma, se etiquetan según su gravedad (Error, Advertencia, Nota) y cada uno incluye una corrección automática sugerida.

  2. ** Conclusiones de IA **: Code Quality usa el análisis con tecnología de inteligencia artificial para identificar problemas de calidad en los archivos insertados más recientemente en la rama predeterminada, incluidos los problemas que el análisis basado en reglas puede no detectar, como los procedimientos recomendados, las convenciones de nomenclatura o las consideraciones de diseño.

Nota:

La página "Conclusiones de IA" de los archivos modificados recientemente está actualmente en versión preliminar pública y está sujeta a cambios.

Para obtener información sobre cómo resolver Conclusiones de IA, vea Corrección de los problemas de calidad del código en archivos fusionados recientemente.

Resolución de un hallazgo estándar

  1. Vaya a la pestaña Security and quality del repositorio.

  2. Haga clic para expandir Calidad del código y, a continuación, haga clic en Conclusiones estándar.

  3. Utilice los filtros del panel para centrarse en los hallazgos que más probablemente afecten a sus puntuaciones de calidad. Por ejemplo, para ver todos los resultados de nivel de error para "Confiabilidad", establezca el filtro en:

    is:open category:reliability severity:error

  4. Los resultados se agrupan por regla. Haga clic en un nombre de regla para ir a una vista detallada de todos los resultados de esa regla.

    Captura de pantalla que muestra una regla en la vista "Conclusiones estándar". El nombre de la regla está resaltado en naranja oscuro.

  5. Haga clic en Mostrar más y revise la explicación de la regla, cuál es la corrección recomendada, admitiendo ejemplos de código y referencias.

Captura de pantalla que muestra los resultados de una regla de calidad de código. El texto "Mostrar más" está resaltado en naranja oscuro.

  1. A la derecha de una búsqueda individual, haga clic en Generar corrección.
  2. Revise la diferencia del cambio propuesto. Si está de acuerdo con ella, haga clic en Abrir solicitud de incorporación de cambios.
  3. En el cuadro de diálogo "Confirmar autofijo en rama", seleccione "Abrir una solicitud de incorporación de cambios" y haga clic en Confirmar cambio.
  4. Cuando la solicitud de extracción de corrección automática esté lista para revisión, cambie su estado de "Borrador" a "Lista para revisión" y espere a que se superen las comprobaciones de CI antes de fusionarla.
  5. Como alternativa, si una búsqueda no es relevante o procesable, haga clic en Descartar. Por ejemplo, podría descartar un hallazgo que ya no se mantiene en el código heredado, es una excepción conocida a los estándares de codificación del equipo o es un falso positivo que no supone un riesgo real de calidad.

Para aumentar una puntuación de mantenibilidad o fiabilidad, debe resolver cada incidencia del nivel de gravedad más alto que esté afectando actualmente a esa métrica. Consulte Referencia de métricas y puntuaciones.

Comprobación de que las puntuaciones de calidad del código se han actualizado

Una vez fusionadas las pull requests de corrección automática, vuelva a la vista "Conclusiones estándar" para confirmar que:

  • El número de hallazgos ha disminuido.
  • La puntuación de mantenibilidad o fiabilidad ha mejorado si ha resuelto todas las incidencias del nivel mínimo de gravedad actual para esa métrica.

Pasos siguientes