Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save morisono/07609b4865f44a87a7dc5bd2ce45bfab to your computer and use it in GitHub Desktop.
Save morisono/07609b4865f44a87a7dc5bd2ce45bfab to your computer and use it in GitHub Desktop.

Revisions

  1. @qoomon qoomon revised this gist Nov 28, 2024. No changes.
  2. @qoomon qoomon revised this gist Nov 28, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    # Conventional Commit Messages [![starline](https://github-starline.vercel.app/gists/5dfcdf8eec66a051ecd85625518cfd13)](https://github.com/qoomon/starline)
    # Conventional Commit Messages [![starline](https://starlines.qoo.monster/assets/gists/5dfcdf8eec66a051ecd85625518cfd13)](https://github.com/qoomon/starline)

    See how [a minor change](#examples) to your commit message style can make a difference.

  3. @qoomon qoomon revised this gist Nov 19, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    # Conventional Commit Messages [![starline](https://github-starline.vercel.app/gist/5dfcdf8eec66a051ecd85625518cfd13)](https://github.com/qoomon/starline)
    # Conventional Commit Messages [![starline](https://github-starline.vercel.app/gists/5dfcdf8eec66a051ecd85625518cfd13)](https://github.com/qoomon/starline)

    See how [a minor change](#examples) to your commit message style can make a difference.

  4. @qoomon qoomon revised this gist Nov 15, 2024. No changes.
  5. @qoomon qoomon revised this gist Nov 15, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    # Conventional Commit Messages ![Starline](https://github-starline.vercel.app/qoomon/5dfcdf8eec66a051ecd85625518cfd13@gist)
    # Conventional Commit Messages [![starline](https://github-starline.vercel.app/gist/5dfcdf8eec66a051ecd85625518cfd13)](https://github.com/qoomon/starline)

    See how [a minor change](#examples) to your commit message style can make a difference.

  6. @qoomon qoomon revised this gist Nov 12, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    # Conventional Commit Messages <sub><img src="https://img.icons8.com/dusk/1600/commit-git.png" height="64" /></sub>
    # Conventional Commit Messages ![Starline](https://github-starline.vercel.app/qoomon/5dfcdf8eec66a051ecd85625518cfd13@gist)

    See how [a minor change](#examples) to your commit message style can make a difference.

  7. @qoomon qoomon revised this gist Oct 8, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -92,7 +92,7 @@ The `footer` should contain any information about **Breaking Changes** and is al
    BREAKING CHANGES: ticket enpoints no longer supports list all entites.
    ```
    * ```
    fix(api): handle empty message in request body
    fix(shopping-cart): prevent order an empty shopping cart
    ```
    * ```
    fix(api): fix wrong calculation of request body checksum
  8. @qoomon qoomon revised this gist Jul 11, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -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

  9. @qoomon qoomon revised this gist Jul 6, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -30,7 +30,7 @@ Revert "<b>&lt;reverted commit subject line&gt;</b>"

    ### Inital Commit
    ```
    init
    chore: init
    ```

    ### Types
  10. @qoomon qoomon revised this gist Jul 6, 2024. 1 changed file with 1 addition and 18 deletions.
    19 changes: 1 addition & 18 deletions conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -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`
  11. @qoomon qoomon revised this gist Jul 6, 2024. 1 changed file with 5 additions and 1 deletion.
    6 changes: 5 additions & 1 deletion conventional-commits-cheatsheet.md
    Original file line number Diff line number Diff line change
    @@ -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/
  12. @qoomon qoomon revised this gist Jun 19, 2024. No changes.
  13. @qoomon qoomon renamed this gist Jun 19, 2024. 1 changed file with 0 additions and 0 deletions.
  14. @qoomon qoomon renamed this gist Jun 10, 2024. 1 changed file with 0 additions and 0 deletions.
  15. @qoomon qoomon revised this gist Jun 10, 2024. No changes.
  16. @qoomon qoomon revised this gist May 31, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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
  17. @qoomon qoomon revised this gist May 31, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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
  18. @qoomon qoomon revised this gist May 31, 2024. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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

  19. @qoomon qoomon revised this gist Mar 30, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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.

  20. @qoomon qoomon revised this gist Mar 30, 2024. 1 changed file with 4 additions and 4 deletions.
    8 changes: 4 additions & 4 deletions conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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

  21. @qoomon qoomon revised this gist Feb 16, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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.
  22. @qoomon qoomon revised this gist Feb 16, 2024. No changes.
  23. @qoomon qoomon revised this gist Feb 16, 2024. 1 changed file with 4 additions and 5 deletions.
    9 changes: 4 additions & 5 deletions conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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
  24. @qoomon qoomon revised this gist Feb 16, 2024. No changes.
  25. @qoomon qoomon revised this gist Feb 16, 2024. 1 changed file with 3 additions and 1 deletion.
    4 changes: 3 additions & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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>
  26. @qoomon qoomon revised this gist Feb 16, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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`
  27. @qoomon qoomon revised this gist Feb 16, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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

  28. @qoomon qoomon revised this gist Feb 12, 2024. 1 changed file with 4 additions and 1 deletion.
    5 changes: 4 additions & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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>
  29. @qoomon qoomon revised this gist Feb 5, 2024. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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
    # ...
  30. @qoomon qoomon revised this gist Feb 5, 2024. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion conventional_commit_messages.md
    Original file line number Diff line number Diff line change
    @@ -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