Einleitung
GitHub Code Quality (öffentliche Vorschau) trägt dazu bei, dass Ihr Code zuverlässig und wartbar bleibt, indem Codequalitätsergebnisse in Pull-Anfragen und Ihrem Hauptzweig 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 Sie benötigen Code in einer unterstützten Sprache. 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.
Überprüfen der Scanergebnisse für Ihren Standardzweig
Wechseln Sie in Ihrem Repository zur Security and quality Registerkarte, klicken Sie Codequalität auf die linke Randleiste, und klicken Sie Standardergebnisse dann, um das Repository-Dashboard 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 durch eine CodeQL-gestützte Analyse auf Ihrem Standardbranch erkannt und nach Regel und Sprache gruppiert werden.
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 von Copilot Autofix
Klicken Sie rechts neben einem hervorgehobenen Fund auf "Lösung erstellen".
Ü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 ( Security and quality Registerkarte, dann Codequalität, dann Standardergebnisse).
Warten Sie ein paar Minuten, bis die nächste Überprüfung abgeschlossen ist. Code Quality Überprüfungen werden nach jedem Push an die Standardverzweigung automatisch erneut durchgeführt.
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 erfolgreich Code Quality und Copilot Autofix verwendet, um die Codegesundheit 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 bei Pull-Requests wirkt, um zu verhindern, dass Probleme mit der Codequalität in Ihren Standardzweig 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 Communitydiskussion.