Einführung
In diesem Tutorial arbeiten Sie einen Backlog von Code Quality Erkenntnissen in Ihrem Standard-Branch durch, priorisieren nach Risiko, beheben die Erkenntnisse mit den größten Auswirkungen und kommunizieren das Ergebnis an die Stakeholder. Sie lernen Folgendes:
- Wie Sie das Dashboard lesen und verstehen, was Ihre Bewertungen bedeuten.
- Wie Sie Behebungsmaßnahmen priorisieren und entscheiden, ob ein Autofix angewendet, an Copilot-Cloud-Agent delegiert oder ein Befund verworfen werden soll.
- Wie sie die Auswirkungen der Korrekturarbeit kommunizieren.
- Welche zusätzlichen Maßnahmen Sie ergreifen können, um zu verhindern, dass der Rückstand wieder wächst.
Dies ist eine geführte Einführung, daher steht das Verständnis mehr im Vordergrund als das Tempo. Die grundlegenden Schritte zum Generieren eines Autofixes oder zum Verwerfen eines Befunds finden Sie in der zugehörigen Anleitung: Behebung von Befunden zur Codequalität in Ihrem Repository-Backlog.
Bevor du anfängst
- Code Quality ist für ein Repository aktiviert, das Sie besitzen oder verwalten. Siehe Aktivieren von GitHub Code Quality.
- Wenn Sie Code Quality erst kürzlich aktiviert haben, warten Sie einige Minuten, bis der erste CodeQL-Scan Ihres Standard-Branchs abgeschlossen ist.
In diesem Lernprogramm verwenden wir ein ausgeführtes Beispiel: ein Repository, dessen Dashboard derzeit Bewertungen von "Zuverlässigkeit: Schlecht" und "Wartungsbarkeit: Fair" für die Codequalität anzeigt.
Schritt 1: Bewerten Sie Ihren aktuellen Punktestand
- Navigieren Sie zur Security and quality Registerkarte Ihres Repositorys.
- Klicken Sie hier, um Codequalität zu erweitern, und klicken Sie dann auf Standardergebnisse.
Hier werden Bewertungen für Zuverlässigkeit und Wartung angezeigt.
Diese Werte werden anhand der Erkenntnisse auf Ihrem Standard-Branch berechnet:
| Metric | Definition | Beispielergebnisse |
|---|---|---|
| Reliability | Bewerten Sie, ob der Code seine beabsichtigte Funktion korrekt, vorhersehbar und konsistent ausführt. Zuverlässiger Code ist frei von Bugs, behandelt Ausnahmen sicher und funktioniert unter normalen Bedingungen sowie Randbedingungen wie erwartet. | Probleme mit Leistung, Parallelität, Fehlerbehandlung, Korrektheit |
| Wartbarkeit | Bewerten Sie, wie einfach es ist, den Code im Laufe der Zeit zu verstehen, zu ändern und zu erweitern. Wartbarer Code folgt bewährten Methoden, vermeidet unnötige Komplexität und ist organisiert, um zukünftige Änderungen und Zusammenarbeit zu erleichtern. | Nicht verwendeter/toter Code, Lesbarkeit, Komplexität, widersprüchliche Benennung, schlechte Trennung von Bedenken |
Jede Bewertung wird durch den höchsten Schweregrad des für diese Metrik noch vorhandenen Befunds bestimmt. Um eine Punktzahl zu erhöhen, müssen Sie jeden Befund auf der aktuellen höchsten Schweregradstufe beheben.
In unserem Beispiel ist Zuverlässigkeit "Schlecht", da immer noch Ergebnisse auf Fehlerebene auftreten, die die Zuverlässigkeit beeinträchtigen. Warnungen und Hinweise sollten beachtet werden, aber solange die Fehler nicht behoben sind, wirken sie sich nicht auf die Bewertung aus.
Schritt 2: Lesen Sie die Liste nach Regel, und konzentrieren Sie sich auf die Ergebnisse mit den höchsten Auswirkungen.
In der Ansicht werden die Standardergebnisse Ergebnisse nach Regel gruppiert. Dies ist hilfreich zu verstehen, da eine einzelne Regel mit vielen Ergebnissen eine wiederholte Codierungsgewohnheiten widerspiegeln kann. Sobald Sie ein Vorkommen verstanden haben, fällt es möglicherweise leichter, die vorgeschlagenen automatischen Korrekturen für alle Vorkommen nachzuvollziehen, wodurch die Behebung schneller erfolgt und sich gebündelt einfacher überprüfen lässt.
Suchen Sie darüber hinaus nach Regeln, die eine Schweregradstufe für einen Ihrer Bewertungen abschließen würden– wenn durch das Löschen einer Regel der letzte verbleibende "Fehler" entfernt wird, der die Zuverlässigkeit beeinflusst, wird Die Bewertung sofort nach oben verschoben.
In unserem Beispiel entfallen auf eine Regel – „Überschriebene Eigenschaft“ – 40 der 128 Befunde, und alle 40 sind auf Fehlerstufe. Wenn dieser behoben würde, würden alle Befunde auf Fehlerstufe entfernt, die sich auf die Zuverlässigkeit auswirken, wodurch unser Score in die nächste Stufe steigen würde.
Schritt 3: Beheben der Ergebnisse
Nachdem Sie eine Regel ausgewählt haben, entscheiden Sie, wie jede Suche behandelt werden soll:
| Assessment | Empfohlene Maßnahme | Hinweise |
|---|---|---|
| Die Feststellung ist legitim. | Klicken Sie auf "Fix generieren ", und öffnen Sie eine Pullanforderung. | Das Klicken auf Fix generieren verbraucht AI credits. Sie können demselben Branch mehrere Autofixe hinzufügen, um Behebungsmaßnahmen in einem Pull Request zusammenzufassen. |
| Das Ergebnis ist nicht anwendbar. Beispielsweise befindet es sich im Legacycode, einem beabsichtigten Muster oder einem falsch positiven Ergebnis. | Klicken Sie auf "Schließen". | Der Befund gilt als behoben und wird aus der Liste der offenen Befunde entfernt. |
In unserem Beispiel erstellen wir automatische Korrekturen für die 40 Meldungen „Überschriebene Eigenschaft“ und öffnen einen Pull Request. Da sie dasselbe Muster verwenden, sind die Korrekturen nahezu identisch. Wir mergen den Pull Request, sobald die CI-Prüfungen erfolgreich sind.
Schritt 4: Kommunizieren von Auswirkungen
Nachdem Sie die Korrektur zusammengeführt haben, kehren Sie zur Ansicht "Standardergebnisse" zurück, und erfassen Sie:
- Die Punktzahl, die sich geändert hat. Beispiel: Zuverlässigkeit: Poor → Fair.
- Die Voraussetzung, die es ermöglichte. Beispielsweise wurden alle Ergebnisse auf Fehlerebene behoben, die sich auf die Zuverlässigkeit auswirken.
- Die Verringerung der offenen Ergebnisse. Beispielsweise von 128 offen auf 88.
In unserem Beispiel verschiebt das Entfernen der Regel „Überschriebene Eigenschaft“ die Zuverlässigkeit von Schlecht auf Ausreichend – die erste Wertverbesserung, auf die das Team verweisen kann.
Wie dies mit dem Rest Ihres Codes in Bezug auf die Codequalität zusammenhängt
Jeder Befund, den Sie heute behoben haben, kann morgen erneut auftreten, wenn neue Pull Requests dieselben Arten von Problemen einführen. So beenden Sie die Neugenerierung des Backlogs:
- Legen Sie einen Zusammenführungsschwellenwert für Ihre Standardverzweigung fest, um Pullanforderungen zu blockieren, die neue Ergebnisse der Codequalität einführen. Siehe Festlegen von Schwellenwerten für die Codequalität für Pullanforderungen.
- Beheben Sie Ergebnisse in der Pull-Anforderung, wenn sie angezeigt werden. Siehe Verhindern, dass Probleme mit der Codequalität Ihren Standard-Branch erreichen.
Problembehandlung
- Die Ergebnisse wurden nach dem Zusammenführen von Korrekturen nicht verschoben. Mindestens ein Ergebnis auf der aktuellen höchsten Schweregradstufe für diese Metrik ist noch offen.
- Der Scan wurde nicht erneut ausgeführt. Code Quality Scans werden automatisch nach jedem Push an die Standardverzweigung ausgeführt. Warten Sie einige Minuten, bis der Workflow abgeschlossen ist.
Fazit
In diesem Tutorial haben Sie die Qualitätsscores Ihres Repositorys überprüft, Backlog-Aufgaben nach Schweregrad und Regel priorisiert, Befunde mithilfe automatischer Korrekturen behoben und das Ergebnis als Score-Veränderung kommuniziert.
Nächste Schritte
- Verringern Sie die technischen Schulden weiter, indem Sie Die Ergebnisse in kürzlich geänderten Dateien korrigieren. Siehe Beheben von Codequalitätsbefunden in kürzlich zusammengeführten Dateien.