mrviniciux · December 5, 2023 22:38 · Nov 11, 2023 · Oct 13, 2023 · Oct 13, 2023 · Oct 9, 2023
diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -31,7 +31,7 @@ Revert "<b>&lt;reverted commit subject line&gt;</b>"
 
 ### Types
 * API relevant changes
-    * `feat` Commits, that adds a new feature
+    * `feat` Commits, that adds or remove a new feature
     * `fix` Commits, that fixes a bug
 * `refactor` Commits, that rewrite/restructure your code, however does not change any API behaviour
     * `perf` Commits are special `refactor` commits, that improve performance

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -81,7 +81,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
   feat(shopping cart): add the amazing button
   ```
 * ```
-  feat: remove ticket list endpoint
+  feat!: remove ticket list endpoint
 
   refers to JIRA-1337
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -33,7 +33,7 @@ Revert "<b>&lt;reverted commit subject line&gt;</b>"
 * API relevant changes
     * `feat` Commits, that adds a new feature
     * `fix` Commits, that fixes a bug
-* `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour
+* `refactor` Commits, that rewrite/restructure your code, however does not change any API behaviour
     * `perf` Commits are special `refactor` commits, that improve performance
 * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
 * `test` Commits, that add missing tests or correcting existing tests

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -74,27 +74,45 @@ The `footer` should contain any information about **Breaking Changes** and is al
 
 
 ### Examples
-* `feat`: <sub>(this commit will)</sub> add email notifications on new direct messages
-* `fix(api)`: <sub>(this commit will)</sub> handle empty message in request body
-* `fix(api)`: <sub>(this commit will)</sub> fix wrong calculation of request body checksum
-* `perf`: <sub>(this commit will)</sub> decrease memory footprint for determine uniqe visitors by using HyperLogLog
-* `build`: <sub>(this commit will)</sub> update dependencies
-* `build(release)`: <sub>(this commit will)</sub> bump version to 1.0.0
-* `feat(shopping cart)`: <sub>(this commit will)</sub> add the amazing button
-* `refactor:` implement fibonacci number calculation as recursion
-* `style`: remove empty line
+* ```
+  feat: add email notifications on new direct messages
+  ```
+* ```
+  feat(shopping cart): add the amazing button
+  ```
 * ```
   feat: remove ticket list endpoint
-  
+
   refers to JIRA-1337
+
   BREAKING CHANGES: ticket enpoints no longer supports list all entites.
   ```
+* ```
+  fix(api): handle empty message in request body
+  ```
+* ```
+  fix(api): fix wrong calculation of request body checksum
+  ```
 * ```
   fix: add missing parameter to service call
-  
+
   The error occurred because of <reasons>.
   ```
-
+* ```
+  perf: decrease memory footprint for determine uniqe visitors by using HyperLogLog
+  ```
+* ```
+  build: update dependencies
+  ```
+* ```
+  build(release): `bump version to 1.0.0
+  ```
+* ```
+  refactor: implement fibonacci number calculation as recursion
+  ```
+* ```
+  style: remove empty line
+  ```
 
 
 ## Git Hook Scripts to ensure commit message header format

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -74,9 +74,15 @@ The `footer` should contain any information about **Breaking Changes** and is al
 
 
 ### Examples
-* ```
-  feat(shopping cart): add the amazing button
-  ```
+* `feat`: <sub>(this commit will)</sub> add email notifications on new direct messages
+* `fix(api)`: <sub>(this commit will)</sub> handle empty message in request body
+* `fix(api)`: <sub>(this commit will)</sub> fix wrong calculation of request body checksum
+* `perf`: <sub>(this commit will)</sub> decrease memory footprint for determine uniqe visitors by using HyperLogLog
+* `build`: <sub>(this commit will)</sub> update dependencies
+* `build(release)`: <sub>(this commit will)</sub> bump version to 1.0.0
+* `feat(shopping cart)`: <sub>(this commit will)</sub> add the amazing button
+* `refactor:` implement fibonacci number calculation as recursion
+* `style`: remove empty line
 * ```
   feat: remove ticket list endpoint
   
@@ -88,19 +94,8 @@ The `footer` should contain any information about **Breaking Changes** and is al
   
   The error occurred because of <reasons>.
   ```
-* ```
-  build(release): bump version to 1.0.0
-  ```
-* ```
-  build: update dependencies
-  ```
-* ```
-  refactor: implement calculation method as recursion
-  ```
-* ```
-  style: remove empty line
-  ```
-
+
+
 
 ## Git Hook Scripts to ensure commit message header format
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -56,7 +56,7 @@ Breaking changes should be indicated by an `!` before the `:` in the subject lin
 The `description` contains a concise description of the change.
 * Is a **mandatory** part of the format
 * Use the imperative, present tense: "change" not "changed" nor "changes"
-  * Think of `This commit will <subject>`
+  * Think of `This commit will...` or `This commit should...`
 * Don't capitalize the first letter
 * No dot (.) at the end
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -9,7 +9,7 @@ See how a minor change to your commit message style can make a difference. [Exam
 
 ### Default
 <pre>
-<b><a href="#types">&lt;type&gt;</a></b></font>(<b><a href="#scopes">&lt;optional scope&gt;</a></b>): <b><a href="#subject">&lt;subject&gt;</a></b>
+<b><a href="#types">&lt;type&gt;</a></b></font>(<b><a href="#scopes">&lt;optional scope&gt;</a></b>): <b><a href="#description">&lt;description&gt;</a></b>
 <sub>empty separator line</sub>
 <b><a href="#body">&lt;optional body&gt;</a></b>
 <sub>empty separator line</sub>
@@ -24,7 +24,7 @@ Merge branch '<b>&lt;branch name&gt;</b>'
 
 ### Revert Commit
 <pre>
-Revert "<b>&lt;first line of reverted commit message&gt;</b>"
+Revert "<b>&lt;reverted commit subject line&gt;</b>"
 </pre>
 <sup>Follows default git revert message</sup>
 
@@ -52,8 +52,8 @@ The `scope` provides additional contextual information.
 Breaking changes should be indicated by an `!` before the `:` in the subject line e.g. `feat(api)!: remove status endpoint`
 * Is an **optional** part of the format
 
-### Subject
-The `subject` contains a succinct description of the change.
+### Description
+The `description` contains a concise description of the change.
 * Is a **mandatory** part of the format
 * Use the imperative, present tense: "change" not "changed" nor "changes"
   * Think of `This commit will <subject>`
@@ -132,8 +132,8 @@ The `footer` should contain any information about **Breaking Changes** and is al
 
   commit_msg_type_regex='feat|fix|refactor|style|test|docs|build'
   commit_msg_scope_regex='.{1,20}'
-  commit_msg_subject_regex='.{1,100}'
-  commit_msg_regex="^(${commit_msg_type_regex})(\(${commit_msg_scope_regex}\))?: (${commit_msg_subject_regex})\$"
+  commit_msg_description_regex='.{1,100}'
+  commit_msg_regex="^(${commit_msg_type_regex})(\(${commit_msg_scope_regex}\))?: (${commit_msg_description_regex})\$"
   merge_msg_regex="^Merge branch '.+'\$"
 
   zero_commit="0000000000000000000000000000000000000000"

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -18,13 +18,13 @@ See how a minor change to your commit message style can make a difference. [Exam
 
 ### Merge Commit
 <pre>
-Merge branch '<b>&lt;BRANCH_NAME&gt;</b>'
+Merge branch '<b>&lt;branch name&gt;</b>'
 </pre>
 <sup>Follows default git merge message</sup>
 
 ### Revert Commit
 <pre>
-Revert "<b>&lt;SUBJECT&gt;</b>"
+Revert "<b>&lt;first line of reverted commit message&gt;</b>"
 </pre>
 <sup>Follows default git revert message</sup>
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -24,7 +24,7 @@ Merge branch '<b>&lt;BRANCH_NAME&gt;</b>'
 
 ### Revert Commit
 <pre>
-Revert '<b>&lt;SUBJECT&gt;</b>'
+Revert "<b>&lt;SUBJECT&gt;</b>"
 </pre>
 <sup>Follows default git revert message</sup>
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -16,12 +16,18 @@ See how a minor change to your commit message style can make a difference. [Exam
 <b><a href="#footer">&lt;optional footer&gt;</a></b>
 </pre>
 
-### Merge
+### Merge Commit
 <pre>
-Merge branch '<b>&lt;branch name&gt;</b>'
+Merge branch '<b>&lt;BRANCH_NAME&gt;</b>'
 </pre>
 <sup>Follows default git merge message</sup>
 
+### Revert Commit
+<pre>
+Revert '<b>&lt;SUBJECT&gt;</b>'
+</pre>
+<sup>Follows default git revert message</sup>
+
 
 ### Types
 * API relevant changes

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -42,6 +42,10 @@ The `scope` provides additional contextual information.
 * Allowed Scopes depends on the specific project
 * Don't use issue identifiers as scopes
 
+### Breaking Changes Indicator
+Breaking changes should be indicated by an `!` before the `:` in the subject line e.g. `feat(api)!: remove status endpoint`
+* Is an **optional** part of the format
+
 ### Subject
 The `subject` contains a succinct description of the change.
 * Is a **mandatory** part of the format

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -46,6 +46,7 @@ The `scope` provides additional contextual information.
 The `subject` contains a succinct description of the change.
 * Is a **mandatory** part of the format
 * Use the imperative, present tense: "change" not "changed" nor "changes"
+  * Think of `This commit will <subject>`
 * Don't capitalize the first letter
 * No dot (.) at the end
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,4 +1,4 @@
-# Conventinal Commit Messages 
+# Conventional Commit Messages 
 See how a minor change to your commit message style can make a difference. [Examples](#examples)
 
 **Have a look at CLI util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits) to ensure this conventions and generate changelogs**
@@ -22,21 +22,13 @@ Merge branch '<b>&lt;branch name&gt;</b>'
 </pre>
 <sup>Follows default git merge message</sup>
 
-### Revert
-<pre>
-Revert "<b>&lt;commit headline&gt;</b>"
-<sub>empty separator line</sub>
-This reverts commit <b>&lt;commit hash&gt;</b>.
-<b>&lt;optinal reason&gt;</b>
-</pre>
-<sup>Follows default git revert message</sup>
 
 ### Types
 * API relevant changes
     * `feat` Commits, that adds a new feature
     * `fix` Commits, that fixes a bug
 * `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour
-    * `perf` Commits are special `refactor` commits, that improves performance
+    * `perf` Commits are special `refactor` commits, that improve performance
 * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
 * `test` Commits, that add missing tests or correcting existing tests
 * `docs` Commits, that affect documentation only
@@ -132,7 +124,6 @@ The `footer` should contain any information about **Breaking Changes** and is al
   commit_msg_subject_regex='.{1,100}'
   commit_msg_regex="^(${commit_msg_type_regex})(\(${commit_msg_scope_regex}\))?: (${commit_msg_subject_regex})\$"
   merge_msg_regex="^Merge branch '.+'\$"
-  revert_msg_regex="^Revert \".+\"\$"
 
   zero_commit="0000000000000000000000000000000000000000"
 
@@ -155,7 +146,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
 
     for commit in $rev_span; do
       commit_msg_header=$(git show -s --format=%s $commit)
-      if ! [[ "$commit_msg_header" =~ (${commit_msg_regex})|(${merge_msg_regex})|(${revert_msg_regex}) ]]; then
+      if ! [[ "$commit_msg_header" =~ (${commit_msg_regex})|(${merge_msg_regex}) ]]; then
         echo "$commit" >&2
         echo "ERROR: Invalid commit message format" >&2
         echo "$commit_msg_header" >&2

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -97,11 +97,6 @@ The `footer` should contain any information about **Breaking Changes** and is al
 * ```
   style: remove empty line
   ```
-* ```
-  revert: refactor: implement calculation method as recursion
-  
-  This reverts commit 221d3ec6ffeead67cee8c730c4a15cf8dc84897a.
-  ```
 
 
 ## Git Hook Scripts to ensure commit message header format

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -86,7 +86,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
   The error occurred because of <reasons>.
   ```
 * ```
-  build: release version 1.0.0
+  build(release): bump version to 1.0.0
   ```
 * ```
   build: update dependencies

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -42,6 +42,7 @@ This reverts commit <b>&lt;commit hash&gt;</b>.
 * `docs` Commits, that affect documentation only
 * `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
 * `ops` Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
+* `chore` Miscellaneous commits e.g. modifying `.gitignore`
 
 ### Scopes
 The `scope` provides additional contextual information.

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -39,7 +39,7 @@ This reverts commit <b>&lt;commit hash&gt;</b>.
     * `perf` Commits are special `refactor` commits, that improves performance
 * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
 * `test` Commits, that add missing tests or correcting existing tests
-* `doc` Commits, that affect documentation only
+* `docs` Commits, that affect documentation only
 * `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
 * `ops` Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -36,7 +36,7 @@ This reverts commit <b>&lt;commit hash&gt;</b>.
     * `feat` Commits, that adds a new feature
     * `fix` Commits, that fixes a bug
 * `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour
-    * `perf` Commits are `refactor` commit, that improves performance
+    * `perf` Commits are special `refactor` commits, that improves performance
 * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
 * `test` Commits, that add missing tests or correcting existing tests
 * `doc` Commits, that affect documentation only

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -110,8 +110,15 @@ The `footer` should contain any information about **Breaking Changes** and is al
   ```shell
   #!/usr/bin/env sh
 
-  # ensure https://github.com/qoomon/git-conventional-commits is installed
-  git-conventional-commits commit-msg-hook "$1"
+  commit_message="$1"
+  # exit with a non zero exit code incase of an invalid commit message
+
+  # use git-conventional-commits, see https://github.com/qoomon/git-conventional-commits
+  git-conventional-commits commit-msg-hook "$commit_message"
+
+  # or verify $commit_message with your own tooling
+  # ...
+
   ```
 * ⚠ make `.git-hooks/commit-msg` executable (unix: `chmod +x '.git-hooks/commit-msg'`)
 * set git hook directory to `.githooks`  `git config core.hooksPath '.git-hooks'`

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,7 +1,7 @@
 # Conventinal Commit Messages 
 See how a minor change to your commit message style can make a difference. [Examples](#examples)
 
-**Have a look at CLI Util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits) to ensure this conventions and generate changelogs**
+**Have a look at CLI util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits) to ensure this conventions and generate changelogs**
 
 <img src="https://img.icons8.com/dusk/1600/commit-git.png" width="200" height="200" />
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,7 +1,7 @@
 # Conventinal Commit Messages 
 See how a minor change to your commit message style can make a difference. [Examples](#examples)
 
-Have a look at CLI Util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits)
+**Have a look at CLI Util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits) to ensure this conventions and generate changelogs**
 
 <img src="https://img.icons8.com/dusk/1600/commit-git.png" width="200" height="200" />
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -41,7 +41,7 @@ This reverts commit <b>&lt;commit hash&gt;</b>.
 * `test` Commits, that add missing tests or correcting existing tests
 * `doc` Commits, that affect documentation only
 * `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
-* `ops` Commits, that affect operational components like infrastructure, backup, recovery, ...
+* `ops` Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
 
 ### Scopes
 The `scope` provides additional contextual information.

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,5 +1,6 @@
 # Conventinal Commit Messages 
 See how a minor change to your commit message style can make a difference. [Examples](#examples)
+
 Have a look at CLI Util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits)
 
 <img src="https://img.icons8.com/dusk/1600/commit-git.png" width="200" height="200" />

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,5 +1,6 @@
 # Conventinal Commit Messages 
 See how a minor change to your commit message style can make a difference. [Examples](#examples)
+Have a look at CLI Util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits)
 
 <img src="https://img.icons8.com/dusk/1600/commit-git.png" width="200" height="200" />
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -107,22 +107,9 @@ The `footer` should contain any information about **Breaking Changes** and is al
 * create following file in your local repository folder`.git-hooks/commit-msg`
   ```shell
   #!/usr/bin/env sh
-
-  # commit-msg hook that will ensure commit messge format
-
-  commit_msg_type_regex='feat|fix|refactor|style|test|docs|build|ops'
-  commit_msg_scope_regex='.{1,20}'
-  commit_msg_subject_regex='.{1,100}'
-  commit_msg_regex="^(${commit_msg_type_regex})(\(${commit_msg_scope_regex}\))?: (${commit_msg_subject_regex})\$"
-  merge_msg_regex="^Merge branch '.+'\$"
-  revert_msg_regex="^Revert \".+\"\$"
-
-  commit_msg_header=$(head -1 $1)
-  if ! [[ "$commit_msg_header" =~ (${commit_msg_regex})|(${merge_msg_regex})|(${revert_msg_regex}) ]]; then
-    echo "ERROR: Invalid commit message format" >&2
-    echo "\n$commit_msg_header" >&2
-    exit 1
-  fi
+
+  # ensure https://github.com/qoomon/git-conventional-commits is installed
+  git-conventional-commits commit-msg-hook "$1"
   ```
 * ⚠ make `.git-hooks/commit-msg` executable (unix: `chmod +x '.git-hooks/commit-msg'`)
 * set git hook directory to `.githooks`  `git config core.hooksPath '.git-hooks'`

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -64,7 +64,7 @@ The `body` should include the motivation for the change and contrast this with p
 The `footer` should contain any information about **Breaking Changes** and is also the place to **reference Issues** that this commit refers to.
 * Is an **optional** part of the format
 * **optionally** reference an issue by its id.
-* **Breaking Changes** should start with the word `BREAKING CHANGES:` folowed by space or two newlines. The rest of the commit message is then used for this.
+* **Breaking Changes** should start with the word `BREAKING CHANGES:` followed by space or two newlines. The rest of the commit message is then used for this.
 
 
 ### Examples

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -64,7 +64,7 @@ The `body` should include the motivation for the change and contrast this with p
 The `footer` should contain any information about **Breaking Changes** and is also the place to **reference Issues** that this commit refers to.
 * Is an **optional** part of the format
 * **optionally** reference an issue by its id.
-* **Breaking Changes** should start with the word `BREAKING CHANGE:` folowed by space or two newlines. The rest of the commit message is then used for this.
+* **Breaking Changes** should start with the word `BREAKING CHANGES:` folowed by space or two newlines. The rest of the commit message is then used for this.
 
 
 ### Examples
@@ -75,7 +75,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
   feat: remove ticket list endpoint
   
   refers to JIRA-1337
-  BREAKING CHANGE: ticket enpoints no longer supports list all entites.
+  BREAKING CHANGES: ticket enpoints no longer supports list all entites.
   ```
 * ```
   fix: add missing parameter to service call

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -30,15 +30,16 @@ This reverts commit <b>&lt;commit hash&gt;</b>.
 <sup>Follows default git revert message</sup>
 
 ### Types
-* `feat` Commits, that adds a new feature, **recognizable by your clients**
-* `fix` Commits, that fixes a bug, **recognizable by your clients**
-* `perf` Commits, that improves performance, **recognizable by your clients**
+* API relevant changes
+    * `feat` Commits, that adds a new feature
+    * `fix` Commits, that fixes a bug
 * `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour
+    * `perf` Commits are `refactor` commit, that improves performance
 * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
 * `test` Commits, that add missing tests or correcting existing tests
 * `doc` Commits, that affect documentation only
-* `build` Commits, that affect the build system or external dependencies
-* `ops` Commits, that affect operational components like infrastructure, backup or recovery
+* `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
+* `ops` Commits, that affect operational components like infrastructure, backup, recovery, ...
 
 ### Scopes
 The `scope` provides additional contextual information.

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -36,7 +36,7 @@ This reverts commit <b>&lt;commit hash&gt;</b>.
 * `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour
 * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
 * `test` Commits, that add missing tests or correcting existing tests
-* `docs` Commits, that affect documentation only
+* `doc` Commits, that affect documentation only
 * `build` Commits, that affect the build system or external dependencies
 * `ops` Commits, that affect operational components like infrastructure, backup or recovery