Skip to content

Instantly share code, notes, and snippets.

@fmnoise

fmnoise/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active January 25, 2023 21:22
Show Gist options
  • Save fmnoise/b9a5543125075d1197fde3f75535b54b to your computer and use it in GitHub Desktop.
Save fmnoise/b9a5543125075d1197fde3f75535b54b to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. fmnoise revised this gist Jan 25, 2023. 1 changed file with 7 additions and 7 deletions.
    14 changes: 7 additions & 7 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -17,13 +17,13 @@ feat: add hat wobble

    More Examples:

    - `feat`: (new feature for the user, not a new feature for build script)
    - `fix`: (bug fix for the business logic, not a fix to a build script)
    - `ref`: (refactoring of business logic)
    - `text`: (text formatting, reword, etc)
    - `tech`: (technical code changes, eg. renaming a variable, update dependency version, etc, no business logic change)
    - `docs`: (changes to the documentation)
    - `test`: (adding missing tests, refactoring tests; no business logic code change)
    - `feat`: new feature for the user, not a new feature for build script
    - `fix`: bug fix for the business logic, not a fix to a build script
    - `ref`: refactoring of business logic or removing a feature
    - `text`: text formatting, reword, etc
    - `tech`: technical code changes, eg. renaming a variable, update dependency version, etc, no business logic change
    - `docs`: changes to the documentation
    - `test`: adding missing tests, refactoring tests; no business logic code change

    If commit introduces breaking change, it should be specified in square parents in the end of commit message eg

  2. fmnoise revised this gist Jan 3, 2023. 1 changed file with 6 additions and 3 deletions.
    9 changes: 6 additions & 3 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -12,16 +12,17 @@ feat: add hat wobble
    | |
    | +-> Summary in present tense.
    |
    +-------> Type: tech, docs, feat, fix, style, test.
    +-------> Type: tech, docs, feat, fix, text, ref, test.
    ```

    More Examples:

    - `feat`: (new feature for the user, not a new feature for build script)
    - `fix`: (bug fix for the business logic, not a fix to a build script)
    - `ref`: (refactoring of business logic)
    - `text`: (text formatting, reword, etc)
    - `tech`: (technical code changes, eg. renaming a variable, update dependency version, etc, no business logic change)
    - `docs`: (changes to the documentation)
    - `style`: (text formatting, reword, etc)
    - `tech`: (technical code changes, eg. renaming a variable, update dependency version, no business logic change)
    - `test`: (adding missing tests, refactoring tests; no business logic code change)

    If commit introduces breaking change, it should be specified in square parents in the end of commit message eg
    @@ -30,4 +31,6 @@ If commit introduces breaking change, it should be specified in square parents i
    fix: only admins can delete users [breaking]
    ```

    Semantically `docs`, `text` and `test` should never introduce breaking changes

    Reference: https://www.conventionalcommits.org
  3. fmnoise revised this gist Jan 3, 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
    @@ -20,9 +20,9 @@ More Examples:
    - `feat`: (new feature for the user, not a new feature for build script)
    - `fix`: (bug fix for the business logic, not a fix to a build script)
    - `docs`: (changes to the documentation)
    - `style`: (formatting, missing semi colons, reword, etc)
    - `style`: (text formatting, reword, etc)
    - `tech`: (technical code changes, eg. renaming a variable, update dependency version, no business logic change)
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `test`: (adding missing tests, refactoring tests; no business logic code change)

    If commit introduces breaking change, it should be specified in square parents in the end of commit message eg

  4. fmnoise revised this gist Jan 3, 2023. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -27,7 +27,7 @@ More Examples:
    If commit introduces breaking change, it should be specified in square parents in the end of commit message eg

    ```
    fix: only admins can delete users [BREAKING]
    fix: only admins can delete users [breaking]
    ```

    Reference: https://www.conventionalcommits.org
  5. fmnoise revised this gist Jan 3, 2023. 1 changed file with 6 additions and 0 deletions.
    6 changes: 6 additions & 0 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -24,4 +24,10 @@ More Examples:
    - `tech`: (technical code changes, eg. renaming a variable, update dependency version, no business logic change)
    - `test`: (adding missing tests, refactoring tests; no production code change)

    If commit introduces breaking change, it should be specified in square parents in the end of commit message eg

    ```
    fix: only admins can delete users [BREAKING]
    ```

    Reference: https://www.conventionalcommits.org
  6. fmnoise revised this gist Jan 3, 2023. 1 changed file with 5 additions and 12 deletions.
    17 changes: 5 additions & 12 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,5 @@
    # Semantic Commit Messages

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

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

    `<scope>` is optional
    @@ -14,21 +12,16 @@ feat: add hat wobble
    | |
    | +-> Summary in present tense.
    |
    +-------> Type: chore, docs, feat, fix, refactor, style, or test.
    +-------> Type: tech, docs, feat, fix, style, 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)
    - `fix`: (bug fix for the business logic, 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)
    - `style`: (formatting, missing semi colons, reword, etc)
    - `tech`: (technical code changes, eg. renaming a variable, update dependency version, no business logic change)
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `chore`: (updating grunt tasks etc; no production code change)

    References:

    - https://www.conventionalcommits.org/
    - https://seesparkbox.com/foundry/semantic_commit_messages
    - http://karma-runner.github.io/1.0/dev/git-commit-msg.html
    Reference: https://www.conventionalcommits.org
  7. @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
  8. @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):

  9. @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
  10. @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