Commit Patterns

Information!
Folgender Text ist übersetzt und zitiert aus folgendem Beiträgen: 

➜ http://karma-runner.github.io/1.0/dev/git-commit-msg.html
➜ https://dev.to/jasonh33/git-commit-patterns-5dm7 
➜ https://www.conventionalcommits.org/en/v1.0.0/

Die Verwendung von Git ist für uns Entwickler etwas Wesentliches, ob in persönlichen Projekten, Open Source, mit vielen Leuten oder einer ganzen Gemeinschaft.

Daher ist es wichtig, dass wir Git Commit richtig einsetzen. Eine kohärente und standardisierte Sprache hilft allen am Projekt Beteiligten, die vorgenommenen Änderungen zu verstehen.

●  CREATED MAIN LOOP & TIMING CONTROL		2  HOURS AGO
●  ENABLED CONIFG FILE PARSING				2  HOURS AGO
●  MISC BUGFIXES							3  HOURS AGO
●╮ CODE ADDITIONS/EDITS						4  HOURS AGO
│● MORE CODE								4  HOURS AGO
│● HERE HAVE CODE							4  HOURS AGO
●╯ AAAAAAAAAAA								4  HOURS AGO
●  ASHJDGAJHDG								9  HOURS AGO
●  MY HANDS ARE TYPING WORDS				14 HOURS AGO
●  HAAAAAAAAAAAAANDS						20 HOURS AGO

In der obigen Abbildung sehen wir, wie schädlich ein schlecht kommentierter Commit sein kann, da wir die Art der aufgetretenen Änderung und deren Kontext nicht verstehen. Langfristig ist der Effekt sogar noch schädlicher, da die Wartbarkeit der Software aufgrund von Inkonsistenzen im Umfang dieser Änderungen und deren Auswirkungen auf das Projekt in der Vergangenheit leidet.

In diesem Sinne lassen Sie uns ein wenig über das Conventional Commits Pattern sprechen.

Was ist das?

Conventional Commits ist eine einfache Konvention für Commit-Nachrichten, die einer Reihe von Regeln folgt und Projekten hilft, eine eindeutige und gut strukturierte Commit-Historie zu haben.

Wie wird es verwendet?

Die Regeln sind sehr einfach, wie unten gezeigt, haben wir einen Typ von Commit, den Kontext (scope) von Commit und die Nachricht (subject) von Commit.

!type(?scope): !subject
<?body>
<?footer>

! steht also für die obligatorischen Attribute und ? für die optionalen Attribute.

Subject: Imperativ statt Vergangenheitsform

Auf diese Weise teilen wir unserem Team mit, was der Commit tun wird, wenn er angewendet wird.

“If applied, this commit will ”

“If applied, this commit will change the markup”, was viel mehr Sinn ergibt als: “If applied, this commit will changed the markup”.

git commit -m "refactor: changed the markup"
git commit -m "refactor: change the markup"

Type: Was sind die Typen von Commits

Der type ist dafür verantwortlich, uns mitzuteilen, welche Änderung oder Iteration vorgenommen wird. Aus den Konventionsregeln ergeben sich die folgenden Typen:

git commit -m "test: add test for create product automation"
git commit -m "feat: implement tracking product service"
git commit -m "refactor: change return log pattern"
git commit -m "style: change function param for objects"
git commit -m "fix: remove getPayment() wrong attribute"
git commit -m "chore: add no-undef rule in eslintrc.json"
git commit -m "docs: add technologies list in readme"
git commit -m "style: remove all blank spaces"
git commit -m "perf: change looping for parallel execution"
git commit -m "build: remove moment.js dependency"
git commit -m "build: add date-fns npm dependency"
git commit -m "revert: back to a215868 commit" 

Hinweis:

• Nur ein type pro Commit;
• Der type ist obligatorisch;
• Wenn du nicht weißt, welchen type du verwenden sollst, handelt es sich wahrscheinlich um eine große Änderung und es ist möglich, diesen Commit in zwei oder mehr Commits aufzuteilen;
• Der Unterschied zwischen build und chore kann recht subtil sein und zu Verwirrung führen, daher müssen wir uns über den richtigen type im Klaren sein. Im Fall von Node.js können wir zum Beispiel denken, dass wir einen chore verwenden, wenn es eine Ergänzung/Änderung an einer bestimmten Entwicklungsabhängigkeit gibt, die in devDependencies vorhanden ist. Für Änderungen/Ergänzungen von allgemeinen Abhängigkeiten zum Projekt, die einen direkten und realen Einfluss auf das System haben, verwenden wir build.

Scope: Kontextualisierung des Commits

An diesem Punkt haben wir es geschafft, die Art der Änderung, die in dem Commit vorgenommen wurde, zu verstehen (commit type) und klar zu verstehen, was der Commit bringen wird, wenn er angewendet wird (commit subject).

Auch wenn der Geltungsbereich nicht obligatorisch ist, kann er dazu verwendet werden, den Commit in einen Kontext zu setzen und dem Thema weniger Verantwortung zu übertragen, um ihn so kurz und prägnant wie möglich zu gestalten. Beachten Sie, dass der Geltungsbereich in den Commit zwischen Klammern eingefügt werden muss.

git commit -m "feat(UserService): add /getAppointments endpoint"

Hinweis:

Scopes müssen mit / getrennt werden.

Body: 

• verwendet den Imperativ, Präsens: „change“, nicht „changed“ oder„changes“
• enthält die Motivation für die Veränderung und stellt sie in Kontrast zum vorherigen Verhalten

Für weitere Informationen über den Nachrichtentext siehe:

• http://365git.tumblr.com/post/3308646748/writing-git-commit-messages
• http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Footer: 

Referenzierung von Themen

Abgeschlossene Themen sollten in einer separaten Zeile in der Fußzeile mit dem Präfix „Closes“ aufgelistet werden, etwa so:

Closes #234

oder im Falle von mehreren Themen:

Closes #123, #245, #992

Breaking changes

Alle bahnbrechende Änderungen müssen in der Fußzeile mit der Beschreibung der Änderung, der Begründung und den Migrationshinweisen erwähnt werden.

BREAKING CHANGE:

`port-runner` command line option has changed to `runner-port`, so that it is
consistent with the configuration file syntax.

To migrate your project, change all the commands, where you use `--port-runner`
to `--runner-port`.

Beispiele:

Beispiel für eine Commit-Meldung:

fix(middleware): ensure Range headers adhere more closely to RFC 2616

Add one new dependency, use `range-parser` (Express dependency) to compute
range. It is more well-tested in the wild.

Fixes #2310

Commit-Meldung mit Beschreibung und BREAKING CHANGE im footer

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Nachricht mit ! verfassen, um auf den BREAKING CHANGE aufmerksam zu machen

feat!: send an email to the customer when a product is shipped

Nachricht mit scope und ! um die Aufmerksamkeit auf den BREANKING CHANGE zu lenken

feat(api)!: send an email to the customer when a product is shipped

Commit-Meldung mit ! und BREAKING CHANGE im Footer

chore!: drop support for Node 6

BREAKING CHANGE: use JavaScript features not available in Node 6.

Commit-Nachricht ohne Text

docs: correct spelling of CHANGELOG

Commit-Nachricht mit scope

feat(lang): add Polish language

Nachricht mit mehreren Absätzen und mehreren Fußzeilen übermitteln

fix: prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: #123

Spezifikation

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

1. Commits MUST be prefixed with a type, which consists of a noun, feat, fix, etc., followed by the OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space.
2. The type feat MUST be used when a commit adds a new feature to your application or library.
3. The type fix MUST be used when a commit represents a bug fix for your application.
4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., fix(parser):
5. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.
6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
7. A commit body is free-form and MAY consist of any number of newline separated paragraphs.
8. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a :<space> or <space># separator, followed by a string value (this is inspired by the git trailer convention).
9. A footer’s token MUST use - in place of whitespace characters, e.g., Acked-by (this helps differentiate the footer section from a multi-paragraph body). An exception is made for BREAKING CHANGE, which MAY also be used as a token.
10. A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
11. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
12. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.
13. If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
14. Types other than feat and fix MAY be used in your commit messages, e.g., docs: update ref docs.
15. The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
16. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.

Deutsche Übersetzung als Orientierung:

Die Schlüsselwörter "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" und "OPTIONAL" in diesem Dokument sind wie in RFC 2119 beschrieben zu interpretieren.

1. Commits MUSS ein Typ vorangestellt werden, der aus einem Substantiv, feat, fix usw. besteht, gefolgt vom OPTIONAL scope, OPTIONAL ! und REQUIRED terminal colon und space.
2. Der Typ feat MUSS verwendet werden, wenn ein Commit eine neue Funktion zu Ihrer Anwendung oder Bibliothek hinzufügt.
3. Der Typ fix MUSS verwendet werden, wenn ein Commit eine Fehlerbehebung für Ihre Anwendung darstellt.
4. Ein Scope KANN nach einem Type angegeben werden. Ein Bereich MUSS aus einem Substantiv bestehen, das einen Abschnitt der Codebasis beschreibt, umgeben von Klammern, z.B. fix(parser):
5. Eine Beschreibung MUSS unmittelbar auf den Doppelpunkt und das Leerzeichen nach dem Präfix type/scope folgen. Die Beschreibung ist eine kurze Zusammenfassung der Codeänderungen, z.B. fix: array parsing issue when multiple spaces were contained in string.
6. Nach der kurzen Beschreibung KANN ein längerer Commit-Body folgen, der zusätzliche Kontextinformationen über die Codeänderungen enthält. Der Textkörper MUSS eine Leerzeile nach der Beschreibung beginnen.
7. Ein Commit-Body ist frei formuliert und KANN aus einer beliebigen Anzahl von durch Zeilenumbrüche getrennten Absätzen bestehen.
8. Eine oder mehrere Fußzeilen KÖNNEN eine Leerzeile nach dem Hauptteil eingefügt werden. Jede Fußzeile MUSS aus einem Wort-Token bestehen, gefolgt von einem :<space>- oder <space>#-Trennzeichen, gefolgt von einem String-Wert (dies orientiert sich an der Git-Trailer-Konvention).
9. Das Token einer Fußzeile MUSS - anstelle von Leerzeichen verwenden, z. B. Acked-by (dies hilft bei der Unterscheidung des Fußzeilenabschnitts von einem Text mit mehreren Absätzen). Eine Ausnahme gilt für BREAKING CHANGE, das ebenfalls als Token verwendet werden KANN.
10. Der Wert einer Fußzeile KANN Leerzeichen und Zeilenumbrüche enthalten, und das Parsing MUSS beendet werden, wenn das nächste gültige Token/Separator-Paar für die Fußzeile erkannt wird.
11. Breaking Changes MÜSSEN im Type/Scope-Präfix eines Commits oder als Eintrag in der Fußzeile angegeben werden.
12. In der Fußzeile MUSS ein Breaking Change aus dem Text BREAKING CHANGE in Großbuchstaben bestehen, gefolgt von einem Doppelpunkt, einem Leerzeichen und einer Beschreibung, z. B. BREAKING CHANGE: environment variables now take precedence over config files.
13. Wenn sie im Präfix type/scope enthalten sind, MÜSSEN BREAKING CHANGE durch ein ! unmittelbar vor dem : angezeigt werden. Wenn ! verwendet wird, KANN BREAKING CHANGE: in der Fußzeile weggelassen werden, und die Commit-Beschreibung MUSS verwendet werden, um die bahnbrechende Änderung zu beschreiben.
14. Andere Typen als feat und fix KÖNNEN in Ihren Commit-Nachrichten verwendet werden, z.B. docs: update ref docs.
15. Die Informationseinheiten, aus denen konventionelle Commits bestehen, MÜSSEN von den Implementierern NICHT in Bezug auf Groß- und Kleinschreibung behandelt werden, mit Ausnahme von BREAKING-CHANGE, das in Großbuchstaben geschrieben werden MUSS.
16. BREAKING-CHANGE MUSS ein Synonym für BREAKING CHANGE sein, wenn es als Token in einer Fußzeile verwendet wird.