Beheben von Codequalität-Feststellungen, bevor Sie Ihren Pull Request zusammenführen

Einleitung

In diesem Tutorial erfahren Sie, wie Sie mit Pull-Requests arbeiten, um Codequalitätsprobleme zu identifizieren, die Ihre Änderungen andernfalls versehentlich einführen können, und wie Sie diese Codequalitätsprobleme mit Copilot Autofix und Copilot-Cloud-Agent angehen und beheben können.

Vorteile frühzeitiger Abfangen von Problemen

Wenn Sie Codequalitätsprobleme frühzeitig abfangen, bleibt die Codebasis Ihres Teams in Form. GitHub Code Quality überprüft Ihren Code auf:

•         **Zuverlässigkeit**: Beispielsweise Logikfehler, unsichere Fehlerbehandlung oder Rennbedingungen, die dazu führen können, dass Ihre App abstürzt oder sich unvorhersehbar verhält. Indem Sie diese Art von Problem frühzeitig beheben, machen Sie Ihre Software robuster und zuverlässiger für Benutzer.
  

•         **Verwendbarkeit**: Beispielsweise duplizierter Code, übermäßig komplexe Logik, nicht verwendete Variablen oder Verstöße gegen bewährte Methoden für das Codieren. Durch das Beheben dieser Probleme können Sie Ihren Code übersichtlicher und einfacher lesen, sodass zukünftige Änderungen schneller und weniger riskant sind.
  

1. Verstehen, wie GitHub Code Quality bei Pull-Anfragen funktioniert

Wenn Sie einen Pull Request öffnen, verwendet GitHub Code QualityCodeQL, um Ihre Änderungen automatisch auf Qualitätsprobleme, wie sie oben beschrieben sind, zu überprüfen.

Die Ergebnisse des CodeQL-Scans werden als Kommentare zu Ihrem Pull-Request gemeldet, die von der github-code-quality[bot]. Jeder Kommentar entspricht einem spezifischen Codequalitätsproblem, das in Ihren Änderungen erkannt wurde und mit einem vorgeschlagenen Autofix enthalten ist.

Kommentare werden nach Schweregrad (Fehler, Warnung, Hinweis) bezeichnet, sodass Sie sehen können, welche Ergebnisse am wichtigsten für die Behebung sind.

2. Priorisieren von Korrekturen basierend auf dem Schweregrad

Scannen Sie die Kommentare, und identifizieren Sie zuerst die Ergebnisse, die den höchsten Schweregrad ("Fehler") aufweisen.

Wenn keine Ergebnisse vom Typ „Fehler“ vorhanden sind, suchen Sie nach Ergebnissen für den nächsten Schweregrad („Warnung“).

Ergebnisse mit hohem Schweregrad deuten auf schwerwiegendere Codequalitätsprobleme hin, die wahrscheinlicher sind, dass Zuverlässigkeits- oder Wartungsprobleme in Ihrer Codebasis auftreten. Durch die Auflösung von Ergebnissen mit hohem Schweregrad führen Sie die wirkungsvollste Arbeit aus, um die Qualität des Codes Ihres Teams aufrechtzuerhalten.

Nutzen Sie Copilot Autofix oder Copilot-Cloud-Agent, um Befunde zu beheben

Copilot Autofix

Kommentare zu der Pullanforderung enthalten ein vorgeschlagenes Autofix , das Sie direkt auf Ihre Pullanforderung übernehmen können. Überprüfen Sie sorgfältig die vorgeschlagene Autokorrektur auf Logik, Sicherheit und Stil, und klicken Sie dann auf Vorschlag übernehmen.

Sie benötigen keine Copilot Lizenz, um diese Vorschläge anzuwenden.

Copilot-Cloud-Agent

Alternativ, wenn Sie über eine Copilot Lizenz verfügen, können Sie die Remediierungsarbeit auch Copilot-Cloud-Agent delegieren. Kommentieren Sie die Pullanforderung und erwähnen Sie @Copilot und bitten Sie Copilot, die erkannten Probleme zu beheben.

          Copilot antwortet mit einem Augen-Emoji (👀) auf Ihren Kommentar, startet eine neue Agent-Sitzung und öffnet eine Pull-Anforderung mit den erforderlichen Fixes.

Sie können die Arbeit von Copilot-Cloud-Agent nachverfolgen.

• In der Pullanforderung wird die Zusammenfassung aktualisiert, während die Arbeit fortschreitet.
• Informationen zur Verwendung der Seite "Agents" oder "Sitzungsprotokolle" finden Sie unter Das Nachverfolgen der GitHub Copilot-Sitzungen.

Zum Aufrufen von Copilot benötigen Sie eine Copilot-Cloud-Agent-Lizenz.
Registrieren für Copilot

4. Verwerfen irrelevanter Ergebnisse

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.

5. Änderungen pushen und auf den Scan warten

Übertragen Sie nach der Behebung oder Verwerfung von Ergebnissen Ihre Änderungen auf die Verzweigung, die Ihrer Pullanforderung zugeordnet ist. GitHub Code Quality überprüft Ihre Änderungen automatisch erneut und aktualisiert die Kommentare für Ihre Pull-Anfrage entsprechend.

6. Überprüfen Sie die Codequalitätsbewertungen Ihres Repositorys.

Jeder mit Schreibzugriff kann die allgemeinen Codequalitätsbewertungen für ein Repository anzeigen, die den Status der Zuverlässigkeit und Wartung des Codes über die Standardverzweigung hinweg zusammenfassen.

Um die Bewertungen Ihres Repositorys anzuzeigen, navigieren Sie zur Security and quality-Registerkarte Ihres Repositorys, erweitern Sie die Codequalität in der Randleiste, und klicken Sie dann auf Standardergebnisse.

Indem Sie Probleme beheben, bevor Sie Ihre Pull-Anforderung zusammenführen, haben Sie direkt zur Aufrechterhaltung dieser Bewertungen beigetragen.

Nächste Schritte

• Behandeln Sie Ergebnisse zur Codequalität in Ihrer Standardverzweigung, und verstehen Sie die Zuverlässigkeits- und Wartbarkeitsbewertungen Ihres Repositorys. Weitere Informationen findest du unter Verbessern der Qualität des Codes Ihres Repositorys.
• Geben Sie Feedback zu GitHub Code Quality in der Communitydiskussion.