Marstlantis/AI-Code-Health-Review

Was macht AI-Code-Health-Review?

Eine evidenzbasierte Codex-Fähigkeit zur Überprüfung von Code, Diffs, Repositories, Tests, Abhängigkeiten, CI/CD, Infrastrukturkonfigurationen und maschinell generierten Analyseberichten.

Überblick

Diese Fähigkeit ermöglicht es KI-Agenten, eine gründliche und evidenzbasierte Überprüfung der Codequalität durchzuführen. Sie analysiert nicht nur den Code selbst, sondern auch die gesamte Entwicklungsumgebung, einschließlich Tests, Abhängigkeiten, Continuous Integration/Continuous Deployment (CI/CD)-Pipelines, Infrastruktur als Code (IaC) und maschinell generierte Analyseberichte.

Funktionen

• Code-Review: Überprüfung von Code auf Logikfehler, Stilprobleme, Sicherheitslücken und Best Practices.
• Diff-Review: Analyse von Codeänderungen (Diffs) auf potenzielle Konflikte und Qualitätsprobleme.
• Repository-Review: Bewertung der gesamten Repository-Struktur, einschließlich Branches, Commits und Historie.
• Testabdeckung: Überprüfung der Testqualität, -abdeckung und -ausführung.
• Abhängigkeitsanalyse: Identifizierung von Sicherheitslücken, veralteten Paketen und Lizenzkonflikten.
• CI/CD-Pipeline-Review: Bewertung der CI/CD-Konfiguration auf Effizienz, Sicherheit und Zuverlässigkeit.
• Infrastruktur-Review: Überprüfung von Infrastructure-as-Code-Dateien (z.B. Docker, Kubernetes, Terraform) auf Fehler und Optimierungen.
• Analyseberichte: Integration und Überprüfung von maschinell generierten Berichten wie Linting-Ergebnisse, Security-Scans (z.B. SAST/DAST) und Metrikberichte.

Nutzung

Die Fähigkeit kann in verschiedenen Szenarien eingesetzt werden:

• Als Teil eines CI/CD-Workflows: Automatisierte Überprüfung für jeden Pull-Request oder jede Codeänderung.
• Bei manuellen Überprüfungen: Entwickler können die Fähigkeit aufrufen, um eine detaillierte Analyse eines bestimmten Codeblocks oder Repositories zu erhalten.
• Für Team-Audits: Regelmäßige Überprüfung der Code-Health über verschiedene Projekte hinweg.

Voraussetzungen

• Zugriff auf das zu überprüfende Repository oder den Code.
• Optional: Konfigurierte CI/CD-Umgebung für automatisierte Scans.
• Optional: Analysewerkzeuge wie black, flake8, pylint, bandit, safety, terraform validate, docker build usw.

Beispiel-Aufrufe

# Überprüfung eines lokalen Code-Diffs
> code-health-review diff ./changes.diff

# Überprüfung des gesamten Repositories
> code-health-review repo ./mein-projekt

# Überprüfung einer CI/CD-Pipeline (z.B. GitHub Actions)
> code-health-review ci .github/workflows/ci.yml

Ausgabe

Die Ausgabe erfolgt in einem strukturierten Format (z.B. JSON oder Markdown) und enthält:

• Zusammenfassung: Überblick über den Gesundheitsstatus des Codes.
• Detailierte Ergebnisse: Aufgeschlüsselt nach Kategorien (Code, Tests, Abhängigkeiten usw.).
• Empfehlungen: Priorisierte Vorschläge zur Verbesserung.
• Evidenzen: Referenzen auf spezifische Codezeilen, Konfigurationsdateien oder Berichte.

Bewährte Praktiken

• Führen Sie regelmäßige Überprüfungen durch, idealerweise nach jeder größeren Codeänderung.
• Integrieren Sie die Fähigkeit in Ihre CI/CD-Pipeline, um manuelle Schritte zu minimieren.
• Verwenden Sie die Ergebnisse als Grundlage für Diskussionen im Team, nicht als alleinige Entscheidungsgrundlage.
• Konfigurieren Sie bei Bedarf benutzerdefinierte Regeln oder Schwellenwerte.

Lizenz

Diese Fähigkeit wird unter der MIT-Lizenz bereitgestellt.

Mitwirken

Beiträge sind willkommen! Bitte lesen Sie die CONTRIBUTING.md-Datei für Details.