IDE-Tools · Foto: Homedust, CC BY 2.0
code-review-generic
Zuletzt aktualisiert:
Typ
Instruction
Lizenz
MIT
Anwendungsfeld
GitHub Copilot
Teams mit Copilot-Reviews
Voraussetzungen
- GitHub Copilot mit Custom-Instructions-Unterstützung
- Eigene Projektstandards zum Ausfüllen der Platzhalter (z. B. Review-Sprache, Architekturvorgaben)
Einordnung
Die Anpassung der Platzhalter ist schnell erledigt, der Nutzen hängt aber davon ab, wie gut sie gefüllt werden.
Generische, anpassbare Code-Review-Checkliste für Copilot
Für wen: Teams mit Copilot-Reviews
Im Detail
Eine generische, priorisierte Review-Checkliste für GitHub Copilot, die von Grund auf zur Anpassung gedacht ist: Sie sortiert Findings nach Schweregrad – von kritisch, das den Merge blockiert, bis hin zu Stilfragen – und deckt Sicherheit, Authentifizierung, Tests und Architektur ab. Der Wert liegt weniger in fixen Inhalten als im Gerüst: Teams ersetzen Platzhalter wie die Review-Sprache oder projektspezifische Standards durch eigene Vorgaben. Im Vergleich zu spezialisierten Regeln wie OWASP-fokussierten deckt sie die Breite ab, dafür weniger tief. Ein guter Ausgangspunkt für Teams ohne eigene Copilot-Review-Instruction.
Schritt für Schritt
- Platzhalter wie die Review-Sprache durch die im Team tatsächlich genutzte Sprache ersetzen.
- Projektspezifische Standards bei Sicherheit, Tests und Architektur ergänzen, statt die generischen Punkte unverändert zu lassen.
- Beachten, dass die Instruction laut Konfiguration nicht für den Coding-Agent gilt.
- An einem echten Pull Request prüfen, ob Copilot Findings korrekt in Kritisch/Wichtig/Vorschlag einordnet.
- Bei falscher Priorisierung die Kategorien in der Datei nachschärfen.
Beispiel aus der Praxis
Ein Team lässt Copilot einen Pull Request mit einer neuen Authentifizierungsfunktion prüfen; eine fehlende Autorisierungsprüfung wird als 🔴 Kritisch markiert, fehlende Tests als 🟡 Wichtig, und ein unklarer Variablenname erscheint nur als 🟢 Vorschlag.
Praxis-Tipp
Ändern Sie zuerst den Abschnitt “Review Language” auf Deutsch und ergänzen Sie projektspezifische kritische Punkte, bevor Sie die Checkliste team-weit ausrollen.
Stolperfallen
Wird die Datei ohne Anpassung übernommen, bleiben Platzhalter wie die Sprachangabe stehen und Reviews wirken unspezifisch. Zudem übersieht man leicht, dass sie laut excludeAgent für den Coding-Agent explizit deaktiviert ist.
Siehe auch
Lizenz & Quelle
- Lizenz: MIT
- Quelle: github.com/github/awesome-copilot
Häufige Fragen.
Ersetzt diese Checkliste eine spezialisierte Sicherheits-Review?
Nein, sie deckt Sicherheit nur als eine von mehreren Kategorien ab und ist breiter, aber weniger tief als etwa OWASP-fokussierte Regeln.
Muss ich die Datei stark anpassen, bevor sie nützlich ist?
Ja, der Wert liegt gerade im Ersetzen der Platzhalter durch eigene Standards, unverändert bleibt sie generisch.
Funktioniert sie auch mit Copilots Coding-Agent?
Nein, laut Konfiguration ist sie für den Coding-Agent ausdrücklich ausgeschlossen.
Inhalt ansehen (code-review-generic.instructions.md)
Lade …
Erfahrungen & Kommentare.
Funktioniert der Instruction bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.
Lade Kommentare …
Passt dazu.
taming-copilot
Zügelt Copilot: keine ungefragten Massen-Änderungen, klare Direktiven-Hierarchie
security-and-owasp
Secure-Coding nach OWASP Top 10 (2025), 55+ Anti-Patterns inkl. KI/LLM-Security
self-explanatory-code-commenting
Weniger, aber bessere Kommentare — Code soll sich selbst erklären
