Changes between Version 1 and Version 2 of CommitMessageGuidelines
- Timestamp:
- 05/26/08 15:58:49 (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CommitMessageGuidelines
v1 v2 3 3 == Allgemeines == 4 4 5 * Alle Commits werden in englischer Sprache dokumentiert. 6 * Jeder Commit sollte mindestens einem Ticket zugeordnet werden können. (Im Zweifelsfall fehlt einfach ein Ticket.) Idealerweise beschränkt sich ein Commit auch auf genau ein Ticket. Dies kann jedoch nicht immer eingehalten werden. 7 * Die Commit Messages sollten einen klaren Überblick über die durchgeführten Änderungen geben, ohne in die Quellen/Diffs sehen zu müssen. Argumentationen warum die eine statt einer anderen Implementierung gewählt wurde, sollten eher als Comment dem zugehörigen Ticket angefügt werden. Generell gilt: so kurz wie möglich, so lang wie nötig. 5 Alle Commits werden in englischer Sprache dokumentiert. 6 7 Jeder Commit sollte mindestens einem Ticket zugeordnet werden können. (Im Zweifelsfall fehlt einfach ein Ticket.) Idealerweise beschränkt sich ein Commit auch auf genau ein Ticket. Dies kann jedoch nicht immer eingehalten werden. 8 9 Die Commit Messages sollten einen klaren Überblick über die durchgeführten Änderungen geben, ohne in die Quellen/Diffs sehen zu müssen. Argumentationen warum die eine statt einer anderen Implementierung gewählt wurde, sollten eher als Comment dem zugehörigen Ticket angefügt werden. Generell gilt: so kurz wie möglich, so lang wie nötig. 10 11 Wird das folgende Format eingehalten, so wird der Kommentar automatisch in die referenzierten Tickets eingefügt. 8 12 9 13 == Format == … … 16 20 }}} 17 21 18 Auf die Ticket-Referenzen geht der folgende Abschnitt genauer ein. 19 20 Die Kurzzusammenfassung besteht idealerweise aus genau einem Satz. 22 Auf die Ticket-Referenzen geht der folgende Abschnitt genauer ein. Die Kurzzusammenfassung besteht idealerweise aus genau einem Satz. 21 23 22 24 Die zweite Zeile sollte wohl freigelassen werden. Ansonsten hat mir TortoiseSVN im Log (manchmal!) die Beschreibung mit der 'Vorschau' angezeigt. … … 30 32 * [Partial fix for ticket #1] 31 33 * [Fix for ticket #1, partial fix for ticket #2] 32 * [In preparation of #1] 34 * [In preparation of ticket #1] 35 * [Related to ticket #1] 33 36 34 37 Oder wenn es gar nicht anders geht (momentan wird nicht sichergestellt, dass mindestens ein Ticket referenziert wird): 35 38 * [Not related to any ticket] 36 39 37 == Beispiel e==40 == Beispiel == 38 41 39 42 {{{ … … 50 53 {{{ 51 54 #!html 52 <span style="color: white"> Geheimtipp</span>55 <span style="color: white">Wird der Commit-Kommentar mit einem Leerzeichen beendet (nicht einem Zeilenumbruch!), so werden alle Prüfungen umgangen. Selbstverständlich sollte dies nur in Sonderfällen eingesetzt werden.</span> 53 56 }}}