Metrik- und Bewertungsreferenz

Grundlegendes zur Terminologie, die von GitHub verwendet wird, um die Qualität des Codes Ihres Repositorys zu bewerten.

In diesem Artikel

Dieser Artikel enthält Definitionen für die Metriken und Bewertungen, die von Code Quality verwendet werden.

Sie können die regelbasierten Ergebnisse für Ihr Repository auf der Registerkarte Sicherheit sowie in der Registerkarte Standardergebnisse unter " Codequalität" einsehen.

Metrikdefinitionen

Die folgende Tabelle enthält Definitionen für jede Metrik, die für Ihr Repository gemeldet wird.

MetricDefinitionBeispielergebnisse
          **Reliability**   | Bewerten Sie, ob der Code seine beabsichtigte Funktion korrekt, vorhersehbar und konsistent ausführt. Zuverlässiger Code ist frei von Bugs, behandelt Ausnahmen sicher und funktioniert unter normalen Bedingungen sowie Randbedingungen wie erwartet. | Probleme mit Leistung, Parallelität, Fehlerbehandlung, Korrektheit, API-Design, Barrierefreiheit, Internationalisierung oder Sicherheit |

| Wartbarkeit | Bewerten Sie, wie einfach es ist, den Code im Laufe der Zeit zu verstehen, zu ändern und zu erweitern. Wartbarer Code folgt bewährten Methoden, vermeidet unnötige Komplexität und ist organisiert, um zukünftige Änderungen und Zusammenarbeit zu erleichtern. | Nicht die Verwendung bewährter Methoden, nicht verwendeter/inaktiver Code, doppelter Code, Komplexität, logische Redundanzen, unzureichende Dokumentation, Abhängigkeitsprobleme |

Schweregrade

Schweregrade werden verwendet, um die potenzielle Auswirkung oder Dringlichkeit eines Codequalitätsbefundes anzugeben. Sie helfen Benutzern, Abhilfemaßnahmen zu priorisieren und Risiken an die Projektbeteiligten zu kommunizieren. Der Schweregrad wird durch die Regel bestimmt, die das Problem identifiziert hat, gemäß den Konventionen von CodeQL und den Branchenstandards.

SchweregradDefinition
          **Error** | Gibt ein Problem mit hohem Schweregrad an, das wahrscheinlich Bugs, Ausfälle oder erhebliche Wartungsrisiken verursacht. |

| Warnung | Gibt ein Problem mit mittlerem Schweregrad an, das sich auf die Codequalität oder Zuverlässigkeit auswirken kann, aber nicht sofort kritisch ist. | | Hinweis | Gibt ein Problem mit geringem Schweregrad, geringfügige Verbesserung oder Empfehlung an. Diese Ergebnisse sind nützlich für die fortlaufende Codeintegrität und -wartung. |

Bewertungsdefinitionen

Diese Bewertungen dienen dazu, die allgemeine Zuverlässigkeit und Wartbarkeit eines Repositorys zusammenzufassen, basierend auf der Schwere der regelbasierten Ergebnisse, die durch CodeQL Scans des vollständigen Standardzweigs gefunden wurden:

RatingDefinitionKriterien (basierend auf Ergebnissen)
          **Sehr gut!**        | Codebase veranschaulicht bewährte Methoden für Zuverlässigkeit und Wartung. | Es wurden keine Codequalitätsfeststellungen gefunden.                              |

| Gute | Codebase hat Probleme mit geringem Schweregrad oder kleinere Verbesserungen werden vorgeschlagen. | ≥1 "Anmerkung"-Ebenenfund | | Fair | Codebase hat Probleme mit mittlerem Schweregrad, die sich auf die Qualität auswirken können, aber nicht kritisch sind. | ≥1 "Warnstufe"-Hinweis | | Verbesserungsbedarf| Codebase hat Probleme mit hohem Schweregrad, einschließlich Fehler oder größere Wartungsrisiken. | ≥1 Fehlerniveau-Ergebnis |

Weiterführende Lektüre

  •         [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality)

  •         [AUTOTITLE](/code-security/code-quality/how-tos/interpret-results)