Behebung von Befunden zur Codequalität in Ihrem Repository-Backlog

Wie Code Quality auf Ihrem Standardbranch funktioniert

Code Quality scannt Ihren Standard-Branch und zeigt Ergebnisse auf den Seiten „Codequalität“ im Tab Security and quality Ihres Repositorys an. Es führt zwei Arten von Analysen aus.

1. ** Standardergebnisse **: Code Quality verwendet CodeQL, um einen deterministischen, regelbasierten Scan Ihres Standard-Branchs durchzuführen. Die Ergebnisse sind nach Regel und Sprache gruppiert, nach Schweregrad (Fehler, Warnung, Hinweis) gekennzeichnet und enthalten jeweils eine vorgeschlagene automatische Korrektur.

2. ** KI-Ergebnisse **: Code Quality verwendet KI-basierte Analysen, um Qualitätsprobleme in den Dateien zu identifizieren, die zuletzt an Ihren Standardzweig verschoben wurden, einschließlich Problemen, die regelbasierte Analysen möglicherweise nicht erkennen können – z. B. bewährte Methoden, Benennungskonventionen oder Entwurfsüberlegungen.

Informationen zum Auflösen KI-Ergebnissefinden Sie unter Beheben von Codequalitätsbefunden in kürzlich zusammengeführten Dateien.

Beheben von Standardbefunden

Sie können Ergebnisse einzeln auflösen oder mehrere Ergebnisse Copilot zuweisen.

Auflösen eines einzelnen Befunds

1. Navigieren Sie zur Security and quality Registerkarte Ihres Repositorys.

2. Klicken Sie hier, um Codequalität zu erweitern, und klicken Sie dann auf Standardergebnisse.

3. Verwenden Sie die Dashboardfilter, um sich auf die Ergebnisse zu konzentrieren, die sich am ehesten auf Ihre Qualitätsbewertungen auswirken. Um beispielsweise alle Ergebnisse auf Fehlerebene für "Zuverlässigkeit" anzuzeigen, legen Sie den Filter auf Folgendes fest:

   is:open category:reliability severity:error

4. Ergebnisse werden nach Regel gruppiert. Klicken Sie auf den Namen einer Regel, um zur Detailansicht aller Ergebnisse für diese Regel zu gelangen.

   

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

1. Klicken Sie rechts neben einem einzelnen Ergebnis auf Korrektur generieren.
2. Überprüfen Sie den Diff der vorgeschlagenen Änderung. Wenn Sie damit einverstanden sind, klicken Sie auf "Pullanforderung öffnen".
3. Wählen Sie im Dialogfeld „Automatische Korrektur für Verzweigung übernehmen“ die Option „Pull Request öffnen“ aus. Klicken Sie dann auf Änderung übernehmen.
4. Wenn der Autofix-Pull-Request zur Überprüfung bereit ist, ändern Sie seinen Status von „Entwurf“ in „Bereit zur Überprüfung“ und warten Sie, bis die CI-Prüfungen erfolgreich abgeschlossen sind, bevor Sie den Pull Request zusammenführen.
5. Alternativ klicken Sie auf Verwerfen, wenn ein Befund nicht relevant oder umsetzbar ist. Sie können beispielsweise einen Befund verwerfen, wenn er sich in nicht mehr gepflegtem Legacy-Code befindet, eine bekannte Ausnahme von den Coding-Standards Ihres Teams ist oder ein Fehlalarm ist, der kein echtes Qualitätsrisiko darstellt.

Um einen Wartbarkeits- oder Zuverlässigkeitswert zu erhöhen, müssen Sie jeden Befund mit dem derzeit höchsten Schweregrad beheben, der diese Metrik aktuell beeinträchtigt. Siehe Referenz für Metriken und Bewertungswerte.

Zuweisen mehrerer Ergebnisse zu Copilot

Wenn Sie viele Findings für eine Regel haben und diese effizient beheben möchten, können Sie diese Findings massenweise auswählen und diese Copilot zur agentengestützten Behebung zuweisen. Copilot öffnet einen Pull Request mit Korrekturen für die ausgewählten Befunde.

Sie benötigen keine Copilot Lizenz, um dieses Feature zu verwenden, aber Ihr Unternehmensbesitzer muss Code Quality für Ihre Organisation zulassen. Siehe Verwendung von GitHub Code Quality in Ihrem Unternehmen zulassen.

Um optimale Ergebnisse zu erzielen, beginnen Sie mit einer einzigen Regel, die viele Befunde mit hohem Schweregrad aufweist. Auf diese Weise können Sie die Qualität der Autofixe für einen zusammenhängenden Satz von Änderungen überprüfen, bevor Sie auf andere Regeln ausweiten.

1. Navigieren Sie zur Security and quality Registerkarte Ihres Repositorys.

2. Klicken Sie hier, um Codequalität zu erweitern, und klicken Sie dann auf Standardergebnisse.

3. Wählen Sie die Befunde aus, die Sie beheben möchten. Sie können bis zu 25 Ergebnisse pro Seite auswählen, jeweils nur eine Seite gleichzeitig.

4. Klicken Sie auf "Zuweisen zu" Copilot.

   

5. Copilot öffnet einen Pull Request mit Korrekturen für die ausgewählten Erkenntnisse. Überprüfen Sie den Pull Request sorgfältig, bevor Sie ihn mergen.

Überprüfen, ob Ihre Codequalitätsbewertungen aktualisiert wurden

Kehren Sie nach dem Zusammenführen der AutoFix-Pullanforderungen zur Ansicht "Standardergebnisse" zurück, um zu bestätigen, dass:

• Die Zahl der Ergebnisse ist zurückgegangen.
• Die Wartbarkeits- oder Zuverlässigkeitsbewertung verbessert sich, falls Sie alle Befunde der aktuell niedrigsten Schweregradstufe für diese Metrik behoben haben.

Nächste Schritte

• Beheben von Codequalitätsbefunden in kürzlich zusammengeführten Dateien