Changes between Version 1 and Version 2 of CommitMessageGuidelines


Ignore:
Timestamp:
05/26/08 15:58:49 (13 years ago)
Author:
Henrik Heimbuerger
Comment:

Completed initial version

Legend:

Unmodified
Added
Removed
Modified
  • CommitMessageGuidelines

    v1 v2  
    33== Allgemeines ==
    44
    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.
     5Alle Commits werden in englischer Sprache dokumentiert.
     6
     7Jeder 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
     9Die 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
     11Wird das folgende Format eingehalten, so wird der Kommentar automatisch in die referenzierten Tickets eingefügt.
    812
    913== Format ==
     
    1620}}}
    1721
    18 Auf die Ticket-Referenzen geht der folgende Abschnitt genauer ein.
    19 
    20 Die Kurzzusammenfassung besteht idealerweise aus genau einem Satz.
     22Auf die Ticket-Referenzen geht der folgende Abschnitt genauer ein. Die Kurzzusammenfassung besteht idealerweise aus genau einem Satz.
    2123
    2224Die zweite Zeile sollte wohl freigelassen werden. Ansonsten hat mir TortoiseSVN im Log (manchmal!) die Beschreibung mit der 'Vorschau' angezeigt.
     
    3032 * [Partial fix for ticket #1]
    3133 * [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]
    3336
    3437Oder wenn es gar nicht anders geht (momentan wird nicht sichergestellt, dass mindestens ein Ticket referenziert wird):
    3538 * [Not related to any ticket]
    3639
    37 == Beispiele ==
     40== Beispiel ==
    3841
    3942{{{
     
    5053{{{
    5154#!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>
    5356}}}