Untersuchung der GitHub-Codequalitätsergebnisse in Ihrer Organisation

Voraussetzungen

• Wenn Ihre Organisation zu einem Unternehmen gehört, muss ein Unternehmensbesitzer Code Quality für Ihre Organisation aktivieren. Siehe Verwendung von GitHub Code Quality in Ihrem Unternehmen zulassen.
• Ihre Organisation muss über Repositorys mit aktiviertem Code Quality verfügen. Siehe Aktivieren von GitHub Code Quality.

Anzeigen von Codequalitätsdaten für Ihre Organisation

Das Dashboard auf Ebene der Organisation hat zwei Registerkarten:

• Auf der Registerkarte " Integrität " wird eine Momentaufnahme der aktuellen Codeintegrität Ihrer Organisation angezeigt.
• Auf der Registerkarte "Trends " wird gezeigt, wie sich offene Ergebnisse über einen ausgewählten Zeitraum geändert haben, sodass Sie den Fortschritt nachverfolgen und Repositorys identifizieren können, die Aufmerksamkeit benötigen.

1. Navigieren Sie auf GitHub zur Hauptseite Ihrer Organisation. Zum Beispiel von https://github.com/settings/organizations.
2. Klicken Sie unter dem Namen Ihrer Organisation auf die Security and quality Registerkarte.
3. Klicken Sie im Abschnitt "Insights" der Randleiste auf Codequalität.

Filtern von Dashboarddaten

Eine Filterleiste am oberen Rand des Dashboards gilt für beide Registerkarten Health und Trends. Sie können nach folgenden Kriterien filtern:

• Zuverlässigkeitsbewertung
• Wartbarkeitsbewertung
• Standardergebnisse
• KI-Ergebnisse
• Thema
• Team
• Sichtbarkeit
• Alle benutzerdefinierten Eigenschaften, die für Ihre Organisation definiert sind

Sie können die Dashboarddaten auch mithilfe des Sortiersteuerelements in derselben Filterleiste sortieren.

Aktuellen Codezustand anzeigen

Die Registerkarte "Zustand" zeigt eine Momentaufnahme des aktuellen Codezustands Ihrer Organisation.

Interpretieren des Bewertungsverteilungsdiagramms

Das Diagramm für die Bewertungsverteilung bietet eine visuelle Übersicht über die Codeintegrität Ihrer Organisation. Jede Blase stellt eine Sammlung von Repositorys mit den gleichen Wartungs- und Zuverlässigkeitsbewertungen dar.

• Die Position jeder Blase zeigt die Gesamtintegrität dieser Repositorys. Höhere Blasen stellen höhere Aufrechterhaltensbewertungen dar, während Blasen weiter rechts höhere Zuverlässigkeitsbewertungen darstellen.
• Das Farb- und Rahmenmuster einer Blase geben den Schweregrad der niedrigeren Bewertung für diese Repositorys an. Zum Beispiel ist eine Blase mit der Bewertung „Schlecht“ in einer der beiden Kategorien stets rot und hat einen gestrichelten Rahmen.
• Die Größe jeder Blase stellt die Anzahl der Repositorys mit dieser bestimmten Bewertungskombination dar.

Fahren Sie mit der Maus über die Blase, um den Wartungsscore, den Zuverlässigkeitsscore und die Anzahl der durch eine bestimmte Blase dargestellten Repositorys anzuzeigen.

Erkunden der Repository-Tabelle

Unterhalb des Blasendiagramms gibt es eine Tabelle, in der alle Repositorys in Ihrer Organisation aufgelistet sind. Hier können Sie Codequalitätsergebnisse zusammen mit detaillierteren Informationen zu diesen Ergebnissen anzeigen.

Sie können die Repositorytabelle in aufsteigender oder absteigender Reihenfolge für eine beliebige Spalte sortieren, indem Sie auf die Spaltenüberschrift klicken.

Untersuchung von Repositories mit niedriger Bewertung

1. Zum Filtern der Dashboarddaten für die Repositorys mit der niedrigsten Leistung klicken Sie im Scoreverteilungsdiagramm auf die Blase mit den niedrigsten kombinierten Bewertungen.
2. Scrollen Sie nach unten zur Repositorytabelle. Standardmäßig wird die Tabelle von der neuesten zur ältesten Repository-Überprüfung sortiert, sodass Sie aktuelle Qualitätsprobleme priorisieren können.
3. Wenn Sie Repositorys mit der höchsten Anzahl von CodeQL Ergebnissen priorisieren möchten, klicken Sie Standardergebnisse zweimal.
4. Um das Dashboard auf Repositoryebene für ein bestimmtes Repository anzuzeigen, klicken Sie auf den Namen des Repositorys.

Nachverfolgen von Qualitätstrends im Laufe der Zeit

Die Registerkarte Trends zeigt, wie sich offene Befunde in den Repositorys, auf die Sie Zugriff haben und die den aktuellen Filtern entsprechen, im Laufe der Zeit entwickelt haben, damit Sie erkennen können, ob sich Ihre Maßnahmen zur Codequalität auswirken und worauf Sie als Nächstes den Fokus legen sollten.

1. Klicken Sie im Dashboard auf Organisationsebene auf die Registerkarte "Trends ".
2. Verwenden Sie die Dropdownliste "Zeitraum ", um einen Zeitraum auszuwählen: die letzten 7, 14 oder 30 Tage.
3. Überprüfen Sie das Diagramm "Offene Ergebnisse im Laufe der Zeit", das die Gesamtanzahl der offenen Ergebnisse in den entsprechenden Repositorys für den ausgewählten Zeitraum anzeigt.
4. Optional können Sie die Schaltflächen oberhalb des Diagramms verwenden, um die Daten nach Integritätsbewertung oder Schweregrad zu gruppieren.
5. Bewegen Sie den Mauszeiger über einen Punkt im Diagramm, um die Anzahl der offenen Ergebnisse für den betreffenden Tag anzuzeigen.

Grundlegendes zu Trendsdaten

Beachten Sie beim Interpretieren des Diagramms Folgendes:

• Das Diagramm basiert auf täglichen Momentaufnahmen offener Ergebnisse. Wenn keine Analyse an einem bestimmten Tag ausgeführt wurde, gibt es möglicherweise keinen Datenpunkt für diesen Tag.

• Historische Daten sind nur verfügbar, wenn Code Quality sie mit dem Erstellen von Momentaufnahmen begonnen haben, sodass der verfügbare Zeitraum anfänglich eingeschränkt sein kann.

• Das Diagramm verfolgt die Gesamtanzahl der offenen Ergebnisse, nicht einzelne Ergebnisse, die geöffnet oder behoben werden. Eine Änderung der Anzahl bedeutet nicht unbedingt, dass Entwickler Probleme behoben oder eingeführt haben.

• Das Aktivieren von Code Quality in zusätzlichen Repositories kann die im Diagramm angezeigte Anzahl der Ergebnisse erhöhen. Eine Erhöhung nach der Aktivierung neuer Repositorys bedeutet nicht unbedingt, dass die Codequalität abnimmt.

• Das Diagramm verfolgt die Gesamtanzahl der geöffneten Ergebnisse für die Repositorys, nach denen Sie derzeit filtern. Die Gesamtanzahl umfasst:

  • Neue Erkenntnisse, die durch Codeänderungen oder beim Aktivieren der Codequalitätsanalyse in neuen Repositorys eingeführt werden
  • Erkenntnisse, die im Code behoben oder von Benutzern verworfen wurden

Identifizieren von Repositorys, die Aufmerksamkeit benötigen

Unter dem Trenddiagramm helfen Ihnen zwei Tabellen zu ermitteln, welche Repositorys für den ausgewählten Zeitraum Aufmerksamkeit benötigen:

• Am stärksten verbesserte Repositorys listet Repositorys mit dem größten Rückgang offener Befunde im ausgewählten Zeitraum auf.
• Repositories mit Verbesserungsbedarf listet die Repositories mit dem größten Anstieg offener Befunde im ausgewählten Zeitraum auf.

Beide Tabellen enthalten die folgenden Spalten:

• Repository: Der Name des Repositorys.
• Insgesamt offen: Die Anzahl der offenen Befunde in dem Repository am Ende des ausgewählten Zeitraums.
• Nettoveränderung: Wie sich die Anzahl offener Findings für das Repository im ausgewählten Zeitraum verändert hat.
• Verworfen: Wie viele Erkenntnisse für das Repository im ausgewählten Zeitraum verworfen wurden.

Die Anzahl der Befunde für ein Repository wird dadurch beeinflusst, dass Befunde behoben oder verworfen werden. Sie können das Dashboard auf Repositoryebene verwenden, um zu bestätigen, was sich geändert hat.

Um ein Repository zu untersuchen, klicken Sie auf seinen Namen, um das Dashboard auf Repositoryebene Code Quality zu öffnen, in dem Sie einzelne Ergebnisse überprüfen und Abhilfemaßnahmen ergreifen können.

Nächste Schritte

Informationen zur Codeintegrität, die im Dashboard auf Repositoryebene verfügbar sind, finden Sie unter Die Codequalitätsergebnisse Ihres Repositorys interpretieren.

Wenn Sie vorhaben, Code Quality für viele Repositorys zu aktivieren, siehe Rollout von GitHub Code Quality in großem Maßstab.