From 80f8c1709fe177aa989544bd32a2f6deb11e5b25 Mon Sep 17 00:00:00 2001 From: antifallobst Date: Thu, 20 Jul 2023 01:21:40 +0200 Subject: [PATCH] Docs: update the commit message format to a modified version of the AngularJS commit message style --- docs/CommitMessageStyle.md | 120 +++++++++++++++++++++++++++++++------ 1 file changed, 101 insertions(+), 19 deletions(-) diff --git a/docs/CommitMessageStyle.md b/docs/CommitMessageStyle.md index 37007f0..fa5d5a4 100644 --- a/docs/CommitMessageStyle.md +++ b/docs/CommitMessageStyle.md @@ -1,29 +1,111 @@ # Commit message style +*This specification is heavily inspired by the [AngularJS commit message format][https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format].* -Commit messages have to align with the following style: +We have very precise rules over how our Git commit messages must be formatted. +This format leads to **easier to read commit history**. -` (): ` +Each commit message consists of a **header**, a **body** (optional), and a **footer** (optional). -Pull requests that don't align with this style probably won't be accepted. -## type -The type of change to be committed. +``` +
+ + + +