csulfrian · September 12, 2024 23:35 · Jul 11, 2024 · Jul 6, 2024 · Jul 6, 2024 · Jul 6, 2024
diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -3,7 +3,7 @@
 See how [a minor change](#examples) to your commit message style can make a difference. 
 
 > [!TIP]
-> Have a look at **[git-conventional-commits](https://github.com/qoomon/git-conventional-commits)** , a CLI util to ensure these conventions and generate verion and changelogs
+> Have a look at **[git-conventional-commits](https://github.com/qoomon/git-conventional-commits)** , a CLI util to ensure these conventions, determine version and generate changelogs
 
 ## Commit Message Formats
 

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -30,7 +30,7 @@ Revert "<b>&lt;reverted commit subject line&gt;</b>"
 
 ### Inital Commit 
 ```
-init
+chore: init
 ```
 
 ### Types

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -125,24 +125,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
 <summary>Click to expand</summary>
 
 ### commit-msg Hook (local)
-* ensure `node` and `npx` command is installed on your local machine
-* create following file in your local repository folder`.git-hooks/commit-msg`
-  ```shell
-  #!/usr/bin/env sh
-
-  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
-  npx 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'`
-* commit `.git-hooks` directory if you want to share them with your team, they only need to call the git config command once after cloning the repository
+* Create a commit-msg hook using [git-conventional-commits cli](https://github.com/qoomon/git-conventional-commits?tab=readme-ov-file#automatically-validate-commit-message-convention-before-commit)
 
 ### pre-receive Hook (server side)
 * create following file in your repository folder `.git/hooks/pre-receive`

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -121,7 +121,9 @@ The `footer` should contain any information about **Breaking Changes** and is al
 ---
 
 ## Git Hook Scripts to ensure commit message header format
-
+<details>
+<summary>Click to expand</summary>
+
 ### commit-msg Hook (local)
 * ensure `node` and `npx` command is installed on your local machine
 * create following file in your local repository folder`.git-hooks/commit-msg`
@@ -191,6 +193,8 @@ The `footer` should contain any information about **Breaking Changes** and is al
   ```
 * ⚠ make `.git/hooks/pre-receive` executable (unix: `chmod +x '.git/hooks/pre-receive'`)
 
+</details>
+
 -----
 ## References
 * https://www.conventionalcommits.org/

diff --git a/conventional_commit_messages_cheatsheet.md → conventional-commits-cheatsheet.md b/conventional_commit_messages_cheatsheet.md → conventional-commits-cheatsheet.md
diff --git a/conventional_commit_messages.md → conventional_commit_messages_cheatsheet.md b/conventional_commit_messages.md → conventional_commit_messages_cheatsheet.md
diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -109,7 +109,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
   build: update dependencies
   ```
 * ```
-  build(release): `bump version to 1.0.0
+  build(release): bump version to 1.0.0
   ```
 * ```
   refactor: implement fibonacci number calculation as recursion

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

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -118,6 +118,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
   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
@@ -1,4 +1,4 @@
-# Conventional Commit Messages <img src="https://img.icons8.com/dusk/1600/commit-git.png" height="64" /> 
+# Conventional Commit Messages <sub><img src="https://img.icons8.com/dusk/1600/commit-git.png" height="64" /></sub>
 
 See how a [minor change](#examples) to your commit message style can make a difference. 
 

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

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -62,7 +62,7 @@ The `description` contains a concise description of the change.
 * Use the imperative, present tense: "change" not "changed" nor "changes"
   * Think of `This commit will...` or `This commit should...`
 * Don't capitalize the first letter
-* No dot (.) at the end
+* No dot (`.`) at the end
 
 ### Body
 The `body` should include the motivation for the change and contrast this with previous behavior.

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -7,11 +7,6 @@ See how a [minor change](#examples) to your commit message style can make a diff
 
 ## Commit Message Formats
 
-### Inital Commit 
-```
-init
-```
-
 ### 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="#description">&lt;description&gt;</a></b>
@@ -33,6 +28,10 @@ Revert "<b>&lt;reverted commit subject line&gt;</b>"
 </pre>
 <sup>Follows default git revert message</sup>
 
+### Inital Commit 
+```
+init
+```
 
 ### Types
 * API relevant changes

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -8,7 +8,9 @@ See how a [minor change](#examples) to your commit message style can make a diff
 ## Commit Message Formats
 
 ### Inital Commit 
-Just `init`
+```
+init
+```
 
 ### Default
 <pre>

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -5,7 +5,7 @@ See how a [minor change](#examples) to your commit message style can make a diff
 
 <img src="https://img.icons8.com/dusk/1600/commit-git.png" width="200" height="200" />
 
-## Commit Messaz Formats
+## Commit Message Formats
 
 ### Inital Commit 
 Just `init`

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -143,7 +143,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
 ### pre-receive Hook (server side)
 * create following file in your repository folder `.git/hooks/pre-receive`
   ```shell
-  #!/usr/bin/env sh
+  #!/usr/bin/env bash
 
   # Pre-receive hook that will block commits with messges that do not follow regex rule
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -5,7 +5,10 @@ See how a [minor change](#examples) to your commit message style can make a diff
 
 <img src="https://img.icons8.com/dusk/1600/commit-git.png" width="200" height="200" />
 
-## Commit Formats
+## Commit Messaz Formats
+
+### Inital Commit 
+Just `init`
 
 ### Default
 <pre>

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -118,6 +118,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
 ## Git Hook Scripts to ensure commit message header format
 
 ### commit-msg Hook (local)
+* ensure `node` and `npx` command is installed on your local machine
 * create following file in your local repository folder`.git-hooks/commit-msg`
   ```shell
   #!/usr/bin/env sh
@@ -126,7 +127,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
   # 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"
+  npx git-conventional-commits commit-msg-hook "$commit_message"
 
   # or verify $commit_message with your own tooling
   # ...

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,5 +1,5 @@
 # Conventional Commit Messages 
-See how a minor change to your commit message style can make a difference. [Examples](#examples)
+See how a [minor change](#examples) to your commit message style can make a difference. 
 
 **ℹ️ [git-conventional-commits](https://github.com/qoomon/git-conventional-commits)**  A CLI util to ensure this conventions and generate changelogs 
 

diff --git a/conventional_commit_messages.md b/conventional_commit_messages.md
@@ -1,7 +1,7 @@
 # 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**
+**ℹ️ [git-conventional-commits](https://github.com/qoomon/git-conventional-commits)**  A CLI util 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
@@ -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