arvid-berndtsson · November 6, 2024 13:49 · Nov 6, 2024 · Nov 6, 2024 · Jun 24, 2024 · Jun 24, 2024
diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -124,6 +124,13 @@ The `footer` should contain any information about **Breaking Changes** and is al
 ---
 
 ## Regex
+
+### Commit
+```
+^(feat|fix|docs|style|refactor|perf|test|build|chore|revert|ops|wip)(\([a-z -]{1,20}\))?!?: .{1,100}
+```
+
+### PR (Title)
 ```
 ^(feat|fix|docs|style|refactor|perf|test|build|chore|revert|ops)(\([a-z -]{1,20}\))?!?: .{1,100}
 ```

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -122,7 +122,13 @@ The `footer` should contain any information about **Breaking Changes** and is al
   ```
 
 ---
-
+
+## Regex
+```
+^(feat|fix|docs|style|refactor|perf|test|build|chore|revert|ops)(\([a-z -]{1,20}\))?!?: .{1,100}
+```
+
+
 ## Git Hook Scripts to ensure commit message header format
 
 ### commit-msg Hook (local)

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -45,7 +45,7 @@ init
 * `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`
-* 
+
 #### Non-standard
 * `wip` Commits (Work-In-Progress) are used to save progress. These commits do not need to contain working code. **NEVER** use `wip` commits on the `main`, `releases`, or `dev` branches.
 

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -47,7 +47,7 @@ init
 * `chore` Miscellaneous commits e.g. modifying `.gitignore`
 * 
 #### Non-standard
-`wip` Commits (Work-In-Progress) are used to save progress. These commits do not need to contain working code. **NEVER** use `wip` commits on the `main`, `releases`, or `dev` branches.
+* `wip` Commits (Work-In-Progress) are used to save progress. These commits do not need to contain working code. **NEVER** use `wip` commits on the `main`, `releases`, or `dev` branches.
 
 ### Scopes
 The `scope` provides additional contextual information.

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -46,7 +46,7 @@ init
 * `ops` Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
 * `chore` Miscellaneous commits e.g. modifying `.gitignore`
 * 
-### Non-standard
+#### Non-standard
 `wip` Commits (Work-In-Progress) are used to save progress. These commits do not need to contain working code. **NEVER** use `wip` commits on the `main`, `releases`, or `dev` branches.
 
 ### Scopes

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -45,7 +45,9 @@ init
 * `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`
-* `wip` Commits (Work-In-Progress), that are used as a method of saving progress. Does not need to be working code. **NEVER** to be used on `main`, `releases` and `dev` branches.
+* 
+### Non-standard
+`wip` Commits (Work-In-Progress) are used to save progress. These commits do not need to contain working code. **NEVER** use `wip` commits on the `main`, `releases`, or `dev` branches.
 
 ### Scopes
 The `scope` provides additional contextual information.

diff --git a/conventional-commits-cheatsheet.md b/conventional-commits-cheatsheet.md
@@ -45,6 +45,7 @@ init
 * `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`
+* `wip` Commits (Work-In-Progress), that are used as a method of saving progress. Does not need to be working code. **NEVER** to be used on `main`, `releases` and `dev` branches.
 
 ### Scopes
 The `scope` provides additional contextual information.

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