Mejora de la calidad del código del repositorio

Introducción

Este tutorial le guía a través del uso GitHub Code Quality para revisar, priorizar y corregir los problemas de mantenimiento del código en el repositorio, lo que le ayuda a reducir sistemáticamente la deuda técnica, mejorar la confiabilidad y el mantenimiento, y comunicar su impacto a las partes interesadas.

Prerrequisitos

•         Code Quality está habilitado en tu repositorio. Consulta [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
  

• Si habilita GitHub Code Quality por primera vez, asegúrese de esperar unos minutos después de dicha habilitación para que se complete una exploración completa CodeQL de la rama predeterminada.

1. Evaluar el estado general del código del repositorio

1. Vaya a la Security and quality pestaña del repositorio y, a continuación, en " Calidad del código", haga clic en Conclusiones estándar.

2. La información general del panel "Conclusiones estándar" proporciona una evaluación inmediata del estado de la rama predeterminada hoy:

   •      **La clasificación de mantenimiento** refleja la presencia y gravedad de los resultados de código fallido, duplicación, complejidad, documentación que falta y errores para seguir los procedimientos recomendados.
     

   •      **La clasificación de confiabilidad** refleja la presencia y gravedad de los resultados para la corrección, el rendimiento, el control de errores, la simultaneidad y la accesibilidad del código.
     

   

2. Identificar y priorizar los resultados más impactantes

En la vista "Conclusiones estándar", verá la lista de resultados del último análisis de la rama predeterminada del repositorio realizado por Code Quality. Estos hallazgos son:

• Agrupado por regla, por lo que puede ver qué tipos de problema afectan más al código base.
• Se asignó un nivel de gravedad ("Error", "Advertencia", "Nota").

Centrarse en los resultados de gravedad alta

Use los filtros del panel para centrarse primero en los resultados de la gravedad más alta ("Errores") y revise qué reglas generan la mayoría de los problemas.

Para mejorar la capacidad de mantenimiento o la clasificación de confiabilidad del repositorio, debe resolver (corregir o descartar) todos los resultados con el nivel de gravedad más alto para esa métrica.

Por ejemplo, para mejorar la métrica "Confiabilidad" del repositorio de Necesidades de mejora a Justo, tendría que abordar y resolver todos los hallazgos de nivel de error que afectan a la confiabilidad. Si tiene uno o varios hallazgos de gravedad de error, la clasificación no puede superar "Requiere mejora". Consulta Referencia de métricas y clasificaciones.

3. Investigar un grupo de hallazgos y comprender el contexto

Una vez que haya identificado una regla con varios resultados que desea solucionar, puede investigar más para comprender los problemas subyacentes.

1. Haga clic en el nombre de la regla que se va a llevar a una vista detallada de todos los resultados de esa regla.

   

2. 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.

   

4. Elegir opciones de corrección

Evalúe todos los resultados resaltados para la validez, el impacto y el riesgo. Para mejorar la calificación de calidad, debe resolver cada hallazgo optando por corregirlo o descartarlo.

Generación de una reparación automática

Si el hallazgo parece válido y relevante para la base de código, puede generar una corrección sugerida.

1. A la derecha de una búsqueda individual, haga clic en Generar corrección.

2. Revise cuidadosamente las diferencias del cambio propuesto y, si está de acuerdo con él, haga clic en Abrir solicitud de incorporación de cambios.

3. En el cuadro de diálogo "Confirmar corrección automática en rama", seleccione "Abrir una solicitud de incorporación de cambios" y haga clic en Confirmar cambio.

   Sugerencia

   Actualmente no es posible generar correcciones automáticas para un grupo de hallazgos de manera masiva.

   Si desea abordar varios hallazgos con una única solicitud de incorporación de cambios, repita los pasos 1 y 2 anteriores y, a continuación, en el cuadro de diálogo "Confirmar corrección automática en la rama", use el nombre de la rama que ya creó para la primera corrección automática y, después, seleccione "Abrir solicitud de incorporación de cambios" y Confirmar cambio.

   La corrección se agregará a la solicitud de incorporación de cambios de borrador existente para la rama.

4. Cuando esté listo, cambie el estado de la solicitud de incorporación de cambios de "Borrador" a "Listo para revisión" y revise cuidadosamente los cambios propuestos. Espere a que las comprobaciones de CI y las pruebas automatizadas se completen y pasen antes de fusionar la solicitud de incorporación de cambios.

Descartar un hallazgo

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.

1. Para descartar un hallazgo, haga clic en .
2. El hallazgo desaparecerá de la lista de hallazgos pendientes. Todavía puede revisar y volver a abrir los resultados descartados en la pestaña "Descartado" en la parte superior de la página.

5. Medir la mejora y comunicar el impacto

Una vez completado el trabajo de corrección, vuelva al panel "Conclusiones estándar" para revisar las métricas de confiabilidad y mantenimiento actualizadas.

Al comunicar su impacto a las partes interesadas, resalte:

• Cualquier reducción del número de hallazgos de "Confiabilidad" o "Capacidad de mantenimiento".
• Cualquier cambio en la puntuación de confiabilidad o mantenibilidad.
• Requisitos que se han cumplido para lograr el cambio en la clasificación. Por ejemplo, la corrección de todos los hallazgos de nivel de advertencia provocó que la clasificación cambiara de "Fair" a "Good".

Use las mejoras en las clasificaciones de calidad y la reducción del número de hallazgos para demostrar el progreso.

6. Aplicar estándares de calidad de código para solicitudes de incorporación de cambios

Si aún no lo ha hecho, configure umbrales de calidad para las solicitudes de incorporación de cambios, para bloquear los cambios en el código base que reducirá el estado del código base. Consulta Establecimiento de umbrales de calidad de código para solicitudes de incorporación de cambios.

Pasos siguientes

• Reduzca aún más la deuda técnica mediante la corrección de los hallazgos en archivos modificados recientemente. Consulta Mejora de la calidad de código combinado recientemente con IA.
• Proporcione comentarios sobre GitHub Code Quality en la discusión de la comunidad.