| Scope - Umfang |
-
Ein Scope kann optional nach einem Type angegeben werden.
Ein Scope muss aus einem Substantiv (auch Abkürzung möglich)
bestehen, das einen Abschnitt der Codebasis beschreibt, der
von Klammern umgeben ist, z.B. fix(parser). Die Klammern
werden automatisch gesetzt, in dem Beispiel müsste man also
'parser' eingeben.
- Die maximale Länge für den Scope beträgt 10 Zeichen.
|
| Description - Beschreibung |
-
Eine Beschreibung muss unmittelbar auf das Leerzeichen nach
dem Type/Scope Präfix folgen. Die Beschreibung ist eine
kurze Zusammenfassung der Code-Änderungen, z.B. fix: array
parsing issue when multiple spaces were contained in string.
-
Man sollte im Imparativ schreiben, mit Großbuchstaben
beginnen und auf Satzzeichen verzichten (z.B. 'Fixes the
dumb bug' statt 'fixed the dumb bug.').
-
Die maximale Länge für die Description beträgt 50 Zeichen.
|
| Body - Körper |
-
Ein längerer Body kann nach der Description bereitgestellt
werden, der zusätzliche kontextuelle Informationen über die
Code-Änderungen liefert. Der Körper muss eine Leerzeile nach
der Beschreibung beginnen. Der Body sollte benutzt werden,
um zu erklären was und warum man getan hat und nicht wie man
es getan hat.
-
Die maximale Länge für den Body beträgt 10 Zeilen à 73
Zeichen.
-
Breaking Changes müssen ganz am Anfang des Bodys oder
am Anfang des Footers stehen. Ein Breaking Change muss als
'BREAKING CHANGE' beschrieben werden, gefolgt von einem
Doppelpunkt und einem Leerzeichen. Eine Beschreibung muss
nach 'BREAKING CHANGE: ' angegeben werden, die beschreibt,
was sich an der API geändert hat, z.B. BREAKING CHANGE:
environment variables now take precedence over config files.
|
| Footer - Fußzeile |
-
Eine Fußzeile von einer oder mehreren Zeilen kann eine
Leerzeile nach dem Body zur Verfügung gestellt werden. Die
Fußzeile muss Metainformationen über den Commit enthalten,
z.B. zugehörige Pull-Requests, Reviewer, Breaking Changes,
mit jeweils einem Teil Metainformation pro Zeile.
-
Die maximale Länge für den Footer beträgt 5 Zeilen à 73
Zeichen.
|