Skip to content

Instantly share code, notes, and snippets.

@rak3rman

rak3rman/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active May 13, 2025 19:21
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save rak3rman/ddea632f1b006efff0ec613e55d59756 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save rak3rman/ddea632f1b006efff0ec613e55d59756 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. rak3rman revised this gist May 13, 2025. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -28,6 +28,8 @@ A method to make your commit messages crystal clear and information dense.

    ### Applied Examples

    _Note: trailing (#...) is the Github PR issue number._

    - [SW-154] (multimeter-probe) feat: reworked parsing extraction stats to report CER metrics (#163)
    - [SW-234] (infra) feat: setup automated postgres-core db backups (#248)
    - [ENG-243] (hono) feat: enabled dev auth middleware override on backend (#157)
  2. rak3rman revised this gist May 13, 2025. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -29,6 +29,8 @@ A method to make your commit messages crystal clear and information dense.
    ### Applied Examples

    - [SW-154] (multimeter-probe) feat: reworked parsing extraction stats to report CER metrics (#163)
    - [SW-234] (infra) feat: setup automated postgres-core db backups (#248)
    - [ENG-243] (hono) feat: enabled dev auth middleware override on backend (#157)

    ## Type Details

  3. rak3rman revised this gist May 13, 2025. 1 changed file with 5 additions and 0 deletions.
    5 changes: 5 additions & 0 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -15,6 +15,7 @@ A method to make your commit messages crystal clear and information dense.

    ## Example

    ### Basic Format
    ```
    [EX-1] (frontend) feat: add hat wobble
    ^----^ ^--------^ ^---^ ^------------^
    @@ -25,6 +26,10 @@ A method to make your commit messages crystal clear and information dense.
    +-> ticket: referenced ticket slug if it exists, typically of the form <PROJECT>-<ID#>
    ```

    ### Applied Examples

    - [SW-154] (multimeter-probe) feat: reworked parsing extraction stats to report CER metrics (#163)

    ## Type Details

    - `feat`: (new feature for the user, not a new feature for build script)
  4. rak3rman revised this gist May 13, 2025. 1 changed file with 9 additions and 7 deletions.
    16 changes: 9 additions & 7 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,25 +1,27 @@
    # Semantic Commit Messages

    See how a minor change to your commit message style can make you a better programmer.
    A method to make your commit messages crystal clear and information dense.

    ## Syntax

    ```
    [ticket] <type>: <subject>
    [ticket] (<scope>) <type>: <subject>
    ```

    - \<ticket>: optional, ticket slug in project management tool
    - \<scope>: optional, high-level context like app or package name
    - \<type>: see details for type choice below
    - \<description>: commit message, what was accomplished

    ## Example

    ```
    [EX-1] feat: add hat wobble
    ^----^ ^--^ ^------------^
    | | |
    | | +-> description: summary in present tense
    | +-> type: chore, docs, feat, fix, refactor, style, or test
    [EX-1] (frontend) feat: add hat wobble
    ^----^ ^--------^ ^---^ ^------------^
    | | | |
    | | | +-> description: summary in present tense
    | | +-> type: chore, docs, feat, fix, refactor, style, or test
    | +-> scope: app, package name, or subcomponent, like frontend, backend, web-scraper
    +-> ticket: referenced ticket slug if it exists, typically of the form <PROJECT>-<ID#>
    ```

  5. rak3rman revised this gist Jan 14, 2024. 1 changed file with 3 additions and 1 deletion.
    4 changes: 3 additions & 1 deletion semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -32,9 +32,11 @@ See how a minor change to your commit message style can make you a better progra
    - `refactor`: (refactoring production code, eg. renaming a variable)
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `chore`: (updating grunt tasks etc; no production code change)
    - `revert`: (reverts to a previous commit)

    ## References

    - https://www.conventionalcommits.org/
    - https://seesparkbox.com/foundry/semantic_commit_messages
    - http://karma-runner.github.io/1.0/dev/git-commit-msg.html
    - http://karma-runner.github.io/1.0/dev/git-commit-msg.html
    - https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/
  6. rak3rman revised this gist Jan 14, 2024. 1 changed file with 9 additions and 9 deletions.
    18 changes: 9 additions & 9 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -5,22 +5,22 @@ See how a minor change to your commit message style can make you a better progra
    ## Syntax

    ```
    <type>(<scope>): <subject>
    [ticket] <type>: <subject>
    ```

    - \<ticket>: optional, ticket slug in project management tool
    - \<type>: see details for type choice below
    - \<scope>: is optional
    - \<subject>: commit message, what was accomplished
    - \<description>: commit message, what was accomplished

    ## Example

    ```
    feat: add hat wobble
    ^--^ ^------------^
    | |
    | +-> Summary in present tense.
    |
    +-------> Type: chore, docs, feat, fix, refactor, style, or test.
    [EX-1] feat: add hat wobble
    ^----^ ^--^ ^------------^
    | | |
    | | +-> description: summary in present tense
    | +-> type: chore, docs, feat, fix, refactor, style, or test
    +-> ticket: referenced ticket slug if it exists, typically of the form <PROJECT>-<ID#>
    ```

    ## Type Details
  7. rak3rman revised this gist Apr 14, 2023. 1 changed file with 8 additions and 2 deletions.
    10 changes: 8 additions & 2 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -2,9 +2,15 @@

    See how a minor change to your commit message style can make you a better programmer.

    Format: `<type>(<scope>): <subject>`
    ## Syntax

    `<scope>` is optional
    ```
    <type>(<scope>): <subject>
    ```

    - \<type>: see details for type choice below
    - \<scope>: is optional
    - \<subject>: commit message, what was accomplished

    ## Example

  8. rak3rman revised this gist Apr 14, 2023. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -17,7 +17,7 @@ feat: add hat wobble
    +-------> Type: chore, docs, feat, fix, refactor, style, or test.
    ```

    More Examples:
    ## Type Details

    - `feat`: (new feature for the user, not a new feature for build script)
    - `fix`: (bug fix for the user, not a fix to a build script)
    @@ -27,7 +27,7 @@ More Examples:
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `chore`: (updating grunt tasks etc; no production code change)

    References:
    ## References

    - https://www.conventionalcommits.org/
    - https://seesparkbox.com/foundry/semantic_commit_messages
  9. @joshbuchea joshbuchea revised this gist Nov 7, 2019. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -27,7 +27,8 @@ More Examples:
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `chore`: (updating grunt tasks etc; no production code change)

    Reference(s):
    References:

    - https://www.conventionalcommits.org/
    - https://seesparkbox.com/foundry/semantic_commit_messages
    - http://karma-runner.github.io/1.0/dev/git-commit-msg.html
  10. @joshbuchea joshbuchea revised this gist May 15, 2017. 1 changed file with 26 additions and 7 deletions.
    33 changes: 26 additions & 7 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,12 +1,31 @@
    # Semantic Commit Messages

    - `chore`: add Oyster build script
    - `docs`: explain hat wobble
    - `feat`: add beta sequence
    - `fix`: remove broken confirmation message
    - `refactor`: share logic between 4d3d3d3 and flarhgunnstow
    - `style`: convert tabs to spaces
    - `test`: ensure Tayne retains clothing
    See how a minor change to your commit message style can make you a better programmer.

    Format: `<type>(<scope>): <subject>`

    `<scope>` is optional

    ## Example

    ```
    feat: add hat wobble
    ^--^ ^------------^
    | |
    | +-> Summary in present tense.
    |
    +-------> Type: chore, docs, feat, fix, refactor, style, or test.
    ```

    More Examples:

    - `feat`: (new feature for the user, not a new feature for build script)
    - `fix`: (bug fix for the user, not a fix to a build script)
    - `docs`: (changes to the documentation)
    - `style`: (formatting, missing semi colons, etc; no production code change)
    - `refactor`: (refactoring production code, eg. renaming a variable)
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `chore`: (updating grunt tasks etc; no production code change)

    Reference(s):

  11. @joshbuchea joshbuchea revised this gist May 15, 2017. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -10,4 +10,5 @@

    Reference(s):

    - https://seesparkbox.com/foundry/semantic_commit_messages
    - https://seesparkbox.com/foundry/semantic_commit_messages
    - http://karma-runner.github.io/1.0/dev/git-commit-msg.html
  12. @joshbuchea joshbuchea created this gist May 15, 2017.
    13 changes: 13 additions & 0 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,13 @@
    # Semantic Commit Messages

    - `chore`: add Oyster build script
    - `docs`: explain hat wobble
    - `feat`: add beta sequence
    - `fix`: remove broken confirmation message
    - `refactor`: share logic between 4d3d3d3 and flarhgunnstow
    - `style`: convert tabs to spaces
    - `test`: ensure Tayne retains clothing

    Reference(s):

    - https://seesparkbox.com/foundry/semantic_commit_messages