Alibaba Cloud DevOps ergänzt Review Memory für teamspezifische Coderichtlinien

Review-Erklärungen in wiederverwendbare Regeln umwandeln

Intelligent Code Review kann häufige Probleme im Code erkennen. Alibaba Cloud zufolge erfordern zuverlässige Reviews jedoch auch ein Verständnis der technischen Einschränkungen, Geschäftsregeln und Teampräferenzen eines Repositorys. Review Memory erfasst Kontext, der in früheren Reviews bereits geklärt wurde, und wendet ihn auf passende künftige Änderungen an.

Die Funktion soll Regeln bewahren, die andernfalls vom Wissen einzelner Teammitglieder abhängen könnten. Dazu gehören etwa von Altsystemen verwendete Schnittstellen, etablierte Verfahren zur Ausnahmebehandlung und zusammengehörige Logik, die bei einer Änderung eines bestimmten Feldes ebenfalls aktualisiert werden muss.

Teams können einen Eintrag für Review Memory hinzufügen, indem sie Intelligent Code Review in einem Kommentar zu einem Merge Request mitteilen, woran sich das System erinnern soll. Anschließend strukturiert das System die Informationen als möglichen Memory-Eintrag für das aktuelle Repository. Sobald der Eintrag aktiv ist, verwenden künftige Reviews ihn automatisch bei der Bewertung relevanter Änderungen.

Vier Arten von Repository-Kontext

Alibaba Cloud nennt vier Kategorien, die sich besonders für Review Memory eignen: Repository-Regeln, geschäftliche Einschränkungen, Teampräferenzen und Erfahrungen mit Risiken. Repository-Regeln können Konventionen beschreiben, die für bestimmte Pakete, Module, Klassen oder Schnittstellen gelten. Geschäftliche Einschränkungen können Kompatibilitätspfade für Altsysteme, Felder in externen Systemen und Anforderungen an schrittweise Einführungen umfassen.

Zu den Teampräferenzen gehören langjährig etablierte Implementierungsansätze, Benennungsstile und Strategien zur Ausnahmebehandlung. Erfahrungen mit Risiken betreffen Arten von Änderungen, die in der Vergangenheit Probleme verursacht haben und zusätzliche Prüfungen erfordern.

Das Unternehmen nennt mehrere Beispiele. Ein Team kann festhalten, dass eine Datenbank Änderungszeitstempel automatisch aktualisiert. Dadurch werden künftige Reviews die fehlende manuelle Zuweisung nicht als Versäumnis bewerten. In einer E-Commerce-Anwendung kann außerdem festgelegt werden, dass für Kurierlieferungen eine Lieferadresse erforderlich ist, während bei der Abholung im Geschäft stattdessen ein Abholstandort ausgewählt werden muss.

Ein weiteres Beispiel betrifft DTOs in einem Kompatibilitätspaket. Eine Regel kann vorschreiben, dass Klassen, deren Namen auf DTO enden, einen öffentlichen Konstruktor ohne Argumente behalten müssen, weil ein Legacy-Kompatibilitätspfad Objekte per Reflection erstellt.

Interner Test meldet weniger falsche Kommentare

Alibaba Cloud zufolge hat das DevOps-Team einen Testsatz erstellt und Vergleichstests durchgeführt, um zu prüfen, ob Review Memory falsche Kommentare aufgrund fehlender Informationen, eines begrenzten Repository-Kontexts oder mangelnder Vertrautheit mit Teamkonventionen reduzieren kann. Bei den Stichproben dieses internen Testsatzes verringerte der Einsatz von Review Memory die Zahl falscher Review-Kommentare um 96.9%.

Das Unternehmen betont ausdrücklich, dass 96.9% eine Verringerung der Zahl falscher Kommentare im internen Testsatz bezeichnet und keine allgemeine Genauigkeitsrate für alle Repositorys und Reviewszenarien darstellt. Alibaba Cloud zufolge sollen dadurch weniger Ablenkungen durch Kommentare mit geringem Nutzen, weniger wiederholte Erklärungen von Teamkonventionen und konsistentere Reviews auf Grundlage derselben Repository-Regeln erreicht werden.

Die Quelle betont außerdem, dass langfristige Memory-Einträge eine Verwaltung benötigen. Repository-Administratoren können Review Memory über Repository Settings, AI Assistant Settings, Intelligent Code Review, Review Memory aktivieren oder deaktivieren. Sie können außerdem eine Genehmigung für Memory-Einträge aktivieren. Danach müssen neu erzeugte mögliche Memory-Einträge von einem Administrator bestätigt werden, bevor sie wirksam werden. So können Teams den Repository-Kontext prüfen, überarbeiten und deaktivieren, anstatt jede einmalige Erklärung auf unbestimmte Zeit aktiv zu lassen.