Die Codequalitätsergebnisse Ihres Repositorys interpretieren

Verstehen Sie die Wartungsbarkeit und Zuverlässigkeit Ihrer Codebasis, damit Sie priorisieren können, wo sich Ihre Teams auf die Wartung konzentrieren.

Wer kann dieses Feature verwenden?

Benutzer*innen mit Schreibzugriff

GitHub Team oder GitHub Enterprise Cloud

In diesem Artikel

Voraussetzungen

Anzeigen des vollständigen Backlogs von Codequalitätsergebnissen

  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.

Wenn Sie KI-basierte Ergebnisse für die zuletzt geänderten Dateien sehen möchten, sehen Sie Beheben von Codequalitätsbefunden in kürzlich zusammengeführten Dateien.

Durchsuchen des Backlogs Ihres Repositorys

Im Dashboard "Standardergebnisse" werden alle Ergebnisse angezeigt, die anhand der CodeQL Analyse auf dem Standardzweig Ihres Repositorys gefunden wurden. Diese Ansicht hilft Ihnen, den vollständigen Backlog von Qualitätsergebnissen zu visualisieren und Arbeit zu priorisieren, um bestimmte Arten von Problemen zu beheben.

Die Übersicht am oberen Rand der Seite fasst die Verhaltbarkeit und Zuverlässigkeit der Codebasis zusammen.

Screenshot des Dashboards „Standardergebnisse” für Ergebnisse der Codequalität. Die Zusammenfassung ist in dunkel orange dargestellt.

Unterhalb der Übersicht wird die vollständige Liste der Ergebnisse mit einer Kopfzeile mit Filtern angezeigt, mit denen Sie sich auf einen bestimmten Satz von Ergebnissen konzentrieren können. Die Ergebnisse sind:

  • Gruppiert nach der Regel, die jedes Ergebnis erkannt hat
  • Innerhalb jeder Regel, alphabetisch nach Dateipfad sortiert

Erkunden Sie die Ergebnisse, indem Sie eine Regel erweitern, um die betroffenen Dateien auflisten und auf den Namen einer Regel klicken, um vollständige Details der Ergebnisse anzuzeigen.

Screenshot der Tabelle „Regeln” im Dashboard „Standardergebnisse” zur Codequalität. Der Regelname „Overwritten property” ist in dunkel orange umrissen.

Interpretieren von Bewertungen und Metriken

Codequalitätsergebnisse sollten immer im Kontext Ihres Repositorys interpretiert werden. Beispiel:

  • Kleine Repositorys oder Repositorys mit nur geringem Code, der in unterstützten Sprachen geschrieben wurde, weisen tendenziell nur wenige Ergebnisse und gute Bewertungen auf.
  • Repositories mit viel generiertem Code können zahlreiche Ergebnisse zur Wartbarkeit aufweisen, was die Bewertung der Wartbarkeit senkt. Dies ist kein Problem, wenn der Quellcode selbst verwaltet werden kann.
  • Große Repositorys mit viel Code in einer vollständig unterstützten Sprache haben oft viele Ergebnisse, auch wenn der Großteil des Codes über gute Wartungs- und Zuverlässigkeitsstandards verfügt.

Weitere Informationen zu den Metriken und zur Berechnung der Bewertungen finden Sie unter Referenz für Metriken und Bewertungswerte.

Nächste Schritte