Eine Änderung so beschreiben, dass Reviewer sie prüfen können

Ziel

Reviewern den Kontext geben, den sie brauchen, um die Änderung in einem Durchgang zu beurteilen, und einen Vermerk hinterlassen, der die Änderung künftigen Betreuenden erklärt.

Voraussetzungen

Eine Änderung, die klein genug ist, um geprüft zu werden; braucht die Beschreibung mehrere Abschnitte mit "ausserdem", ist die Änderung aufzuteilen.

Schritte

1. Problem: was fehlt oder ist falsch, mit einem Link zum Ticket oder zur Beobachtung, die die Arbeit ausgelöst hat.
2. Ansatz: was die Änderung tut und warum auf diese Weise; erwogene Alternativen nennen und warum sie verworfen wurden.
3. Umfang: was bewusst nicht enthalten ist, und geplante Folgearbeiten.
4. Testen: was ausgeführt wurde (automatisierte Tests, manuelle Schritte, Umgebungen) und was nicht; angeben, wie ein Reviewer es nachvollziehen kann.
5. Risiko und Rollout: Migrationen, Feature-Toggles, Rückwärtskompatibilität, nach dem Deployment zu beobachtendes Monitoring, Rollback-Pfad.
6. Prüfhinweise: wo zuerst hinzuschauen ist, und bei welchen Entscheidungen Unsicherheit besteht.
7. Die Beschreibung während der Prüfung aktuell halten, während sich die Änderung weiterentwickelt; die gemergte Beschreibung sollte zum gemergten Code passen.

Erwartetes Ergebnis

Weniger Prüfrunden, die für die Klärung der Absicht aufgewendet werden; eine Historie, in der jede gemergte Änderung sich selbst erklärt.

Grenzen und Prüfbasis

Vorlagen helfen nur, wenn sie mit Substanz gefüllt werden; leere Überschriften sind Rauschen. Triviale Änderungen verdienen eine einzeilige Beschreibung. Es wird keine Messung behauptet.