Einleitung
GitHub Code Quality (öffentliche Vorschau) trägt dazu bei, dass Ihr Code zuverlässig ist und einfacher verwaltet werden kann, indem Ergebnisse zur Codequalität in Pull-Anfragen und auf Ihrer Standardverzweigung angezeigt werden.
In diesem Tutorial lernen Sie, wie Sie einen Codequalitätsbefund in Ihrer Standardverzweigung identifizieren und beheben, um die Codegesundheit Ihres Repositorys zu verbessern.
Voraussetzungen
- GitHub Code Quality muss für Ihr Repository aktiviert sein, und es muss Code in einer unterstützten Sprache vorhanden sein. Weitere Informationen findest du unter Aktivieren von GitHub Code Quality.
- Wenn Sie GitHub Code Quality zum ersten Mal aktivieren, müssen Sie nach der Aktivierung einige Minuten warten, bis eine vollständige CodeQL-Überprüfung der Standardverzweigung abgeschlossen ist.
Überprüfen der Scanergebnisse für Ihren Standardzweig
Wechseln Sie in Ihrem Repository zur Registerkarte " Sicherheit ", klicken Sie in der linken Randleiste auf Codequalität und dann auf Standardergebnisse , um das Repositorydashboard zu öffnen.
Hier sehen Sie:
-
Bewertungen für die Zuverlässigkeit und Wartung Ihrer Codebasis, die Ihnen helfen, ihre Codeintegrität auf einen Blick zu verstehen.
-
Eine Ergebnisliste aller Qualitätsprobleme, die von einer CodeQL-gestützten Analyse in Ihrem Standardzweig durchgeführt wurde und die nach Regel und Sprache gruppiert sind.
Eine Feststellung mit hohem Einfluss identifizieren
Um ein Ergebnis mit hohem Schweregrad ("Fehler" oder "Warnung") zu identifizieren, verwenden Sie die Dashboardfilter.
Die Lösung dieser Probleme wird die größte Auswirkung auf die Bewertungen Ihres Repositorys haben.
Überprüfen der Details des Ergebnisses
Klicken Sie auf den Regelnamen selbst, um eine detaillierte Ansicht der Dateien und Codezeilen anzuzeigen, die von dieser Regel betroffen sind.
Sobald Sie sich in der detaillierten Ansicht befinden, klicken Sie auf "Mehr anzeigen ", um Kontext zu sammeln und die Ergebnisse zu verstehen.
Generieren eines Copilot Autofix
Klicken Sie rechts neben einer hervorgehobenen Erkenntnis auf -Korrektur generieren.
Überprüfen Sie den vorgeschlagenen Fix, und klicken Sie dann auf "Pullanforderung öffnen".
Zusammenführen der Korrektur
Überprüfen Sie den Entwurf des Pull Requests sorgfältig. Wenn Sie mit den vorgeschlagenen Änderungen zufrieden sind und alle Prüfungen und Tests bestanden werden, fahren Sie fort, und führen Sie die Pullanforderung zusammen.
Beobachten Sie die Änderung der Metriken
Kehren Sie zum Code Quality-Dashboard zurück (Registerkarte Sicherheit, dann Codequalität, dann Standardergebnisse).
Warten Sie einige Minuten, bis der nächste Scan abgeschlossen ist – Code Quality scannt nach jedem Push an die Standardverzweigung automatisch erneut.
Beobachten Sie die Änderung der Metriken am oberen Rand des Dashboards:
-
Die Anzahl der Ergebnisse für "Zuverlässigkeit" oder "Verwendbarkeit" sollte verringert werden.
-
Ihre Bewertungen für "Zuverlässigkeit" oder "Verwendbarkeit" wurden möglicherweise verbessert, wenn Ihr Fix eine Reihe von Ergebnissen mit hohen Auswirkungen behoben hat.
Weitere Informationen zur Berechnung der Bewertungen finden Sie unter Metrik- und Bewertungsreferenz.
Conclusion
Sie haben Code Quality und Copilot Autofix erfolgreich verwendet, um die Codequalität Ihres Repositorys zu verbessern!
Gesunder Code ist einfacher zu verstehen, zu verwalten und zu erweitern und Codequalitätsprobleme zu beheben, macht Ihre Codebasis zuverlässiger, konformer und beschleunigt die zukünftige Entwicklung.
Nächste Schritte
- Erfahren Sie, wie GitHub Code Quality für Pullanforderungen funktioniert, um zu verhindern, dass Codequalitätsprobleme in die Standardverzweigung gelangen. Weitere Informationen findest du unter Beheben von Codequalität-Feststellungen, bevor Sie Ihren Pull Request zusammenführen.
- Geben Sie Feedback zu GitHub Code Quality in der Diskussion in der Community.