Verbessern der Qualität des Codes Ihres Repositorys

Einleitung

Dieses Lernprogramm leitet Sie durch die Verwendung von GitHub Code Quality zum Überprüfen, Priorisieren und Beheben von Codeintegritätsproblemen in Ihrem Repository – es hilft Ihnen, technische Schulden systematisch zu reduzieren, die Zuverlässigkeit und Wartungsfreundlichkeit zu verbessern und Ihre Auswirkungen den Stakeholdern zu kommunizieren.

Voraussetzungen

•         Code Quality ist für Ihr Repository aktiviert. Weitere Informationen findest du unter [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
  

• Wenn Sie GitHub Code Quality zum ersten Mal aktivieren, stellen Sie sicher, dass Sie einige Minuten nach der Aktivierung auf einen vollständigen CodeQL-Scan der Standardverzweigung gewartet haben.

1. Bewerten Sie die allgemeine Codegesundheit Ihres Repositorys

1. Navigieren Sie zur Security and quality Registerkarte Ihres Repositorys, dann klicken Sie unter " Codequalität" auf Standardergebnisse.

2. Die Übersicht auf dem Dashboard "Standardergebnisse" gibt Ihnen eine sofortige Bewertung des Status Ihrer Standardverzweigung heute:

   •      **Die Bewertung der Wartbarkeit** spiegelt das Vorhandensein und den Schweregrad der Ergebnisse für toten Code, Duplizierung, Komplexität, fehlende Dokumentation und Fehler bei der Einhaltung bewährter Methoden wider.
     

   •      **Die Zuverlässigkeitsbewertung** spiegelt das Vorhandensein und den Schweregrad der Ergebnisse für Korrektheit, Leistung, Fehlerbehandlung, Parallelität und Barrierefreiheit Ihres Codes wider.
     

   

2. Identifizieren und Priorisieren der wirkungsvollsten Ergebnisse

In der Ansicht "Standardergebnisse" wird die Liste der Ergebnisse aus Code Qualityletzten Scan des Standardzweigs des Repositories angezeigt. Diese Ergebnisse sind:

• Gruppiert nach Regel, damit Sie sehen können, welche Arten von Problemen sich am meisten auf Ihre Codebasis auswirken.
• Zugewiesene Schweregrad ("Fehler", "Warnung", "Hinweis").

Konzentrieren Sie sich auf Ergebnisse mit hohem Schweregrad

Verwenden Sie die Dashboardfilter , um sich zuerst auf die Ergebnisse mit dem höchsten Schweregrad ("Fehler") zu konzentrieren und zu überprüfen, welche Regeln die meisten Probleme generieren.

Um die Aufrechterhaltungs- oder Zuverlässigkeitsbewertung Ihres Repositorys zu verbessern, müssen Sie alle Ergebnisse mit dem höchsten Schweregrad für diese Metrik auflösen (korrigieren oder schließen).

Um z. B. die Metrik "Zuverlässigkeit" Ihres Repositorys von bedarfsgerecht auf Fair zu verbessern, müssen Sie alle Ergebnisse auf Fehlerebene beheben und beheben, die sich auf die Zuverlässigkeit auswirken. Wenn Sie einen oder mehrere Fehlerbefunde haben, kann Ihre Bewertung nicht höher sein als "Verbesserungsbedarf". Weitere Informationen findest du unter Metrik- und Bewertungsreferenz.

3. Untersuchen einer Gruppe von Ergebnissen und Verstehen des Kontexts

Nachdem Sie eine Regel mit mehreren Ergebnissen identifiziert haben, die Sie beheben möchten, können Sie die zugrunde liegenden Probleme weiter untersuchen.

1. Klicken Sie auf den Regelnamen, um zu einer detaillierten Ansicht aller Ergebnisse für diese Regel zu gelangen.

   

2. Klicken Sie auf "Mehr anzeigen" und lesen Sie die Erläuterung der Regel, die empfohlene Korrektur sowie die unterstützenden Codebeispiele und Verweise.

   

4. Auswählen von Korrekturoptionen

Bewerten Sie alle hervorgehobenen Ergebnisse auf Gültigkeit, Auswirkung und Risiko. Um Ihre Qualitätsbewertung zu verbessern, müssen Sie jede Feststellung beheben, indem Sie entweder die Feststellung korrigieren oder verwerfen.

Generieren einer automatischen Korrektur

Wenn das Ergebnis gültig und relevant für Ihre Codebasis ist, können Sie eine vorgeschlagene Korrektur generieren.

1. Klicken Sie rechts neben einem individuellen Ergebnis auf "Reparatur generieren".

2. Überprüfen Sie sorgfältig den Diff der vorgeschlagenen Änderung, und klicken Sie, wenn Sie damit einverstanden sind, auf "Pull-Anforderung öffnen".

3. Wählen Sie im Dialogfeld „Automatische Korrektur für Verzweigung übernehmen“ die Option „Pullanforderung öffnen“ aus. Klicken Sie dann auf Änderung übernehmen.

   Tipp

   Es ist derzeit nicht möglich, automatische Korrekturen im großen Stil für eine Gruppe von Ergebnissen zu generieren.

   Wenn Sie mehrere Ergebnisse mit einer einzelnen Pullanforderung verarbeiten möchten, wiederholen Sie die Schritte 1 und 2 oben. Verwenden Sie dann im Dialogfeld „Automatische Korrektur für Verzweigung übernehmen“ den Verzweigungsnamen, den Sie für die erste automatische Korrektur bereits erstellt haben. Wählen Sie dann „Pullanforderung öffnen“ und Commit übernehmen aus.

   Die Korrektur wird dem vorhandenen Pullanforderungsentwurf für Ihre Verzweigung hinzugefügt.

4. Wenn Sie bereit sind, ändern Sie den Pull-Anforderungsstatus von "Entwurf" in "Bereit zur Überprüfung", und überprüfen Sie die vorgeschlagenen Änderungen sorgfältig. Warten Sie, bis die CI-Prüfungen und automatisierten Tests abgeschlossen und bestanden sind, bevor Sie den Pull-Request zusammenführen.

Eine Feststellung ignorieren

Sie können ein Ergebnis verwerfen, wenn es im Kontext Ihrer Codebasis nicht relevant oder umsetzbar ist. Häufige Gründe zum Zurückweisen einer Feststellung sind:

• Das Ergebnis befindet sich im Legacy-Code, der nicht mehr gepflegt wird.
• Es ist eine bekannte Ausnahme für die Codierungsstandards Ihres Teams.
• Es ist ein falsch positives Ergebnis, das kein echtes Qualitätsrisiko darstellt.

Durch das Ausblenden irrelevanter Warnungen werden Ihre Qualitätsüberprüfungen auf aussagekräftige Probleme konzentriert.

1. Um ein Ergebnis zu schließen, klicken Sie auf .
2. Der Befund wird aus der Liste der offenen Befunde entfernt. Sie können abgewiesene Befunde weiterhin auf der Registerkarte "Abgewiesen" oben auf der Seite ansehen und erneut öffnen.

5. Messen der Verbesserung und Kommunikation von Auswirkungen

Kehren Sie nach Abschluss der Wartung zum Dashboard "Standardergebnisse" zurück, um die aktualisierten Zuverlässigkeits- und Wartungsmetriken zu überprüfen.

Heben Sie beim Kommunizieren Ihrer Auswirkungen auf die Projektbeteiligten Folgendes hervor:

• Jede Verringerung der Anzahl der Ergebnisse für "Zuverlässigkeit" oder "Verwendbarkeit".
• Jede Änderung der Bewertung für die Bewertungen "Zuverlässigkeit" oder "Maintainability".
• Die Anforderungen, die erfüllt wurden, um die Änderung der Bewertung zu erreichen. Beispielsweise führte die Behebung aller Ergebnisse auf Warnungsebene dazu, dass sich die Bewertung von "Fair" in "Good" änderte.

Verwenden Sie die Verbesserungen der Qualitätsbewertungen und die Verringerung der Anzahl der Ergebnisse, um den Fortschritt zu demonstrieren.

6. Erzwingen von Codequalitätsstandards für Pullanforderungen

Falls noch nicht geschehen, richten Sie Qualitätsschwellenwerte für Pullanforderungen ein, um Änderungen an der Codebasis zu blockieren, die den Status Ihrer Codebasis verringern. Weitere Informationen findest du unter Festlegen von Schwellenwerten für die Codequalität für Pullanforderungen.

Nächste Schritte

• Verringern Sie die technischen Schulden weiter, indem Sie Die Ergebnisse in kürzlich geänderten Dateien korrigieren. Weitere Informationen findest du unter Verbesserung der Qualität von kürzlich zusammengeführten Codes durch KI.
• Geben Sie Feedback zu GitHub Code Quality in der Communitydiskussion.