Skip to content

Instantly share code, notes, and snippets.

@heymage

heymage/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active November 18, 2021 15:38
Show Gist options
  • Save heymage/b10facd1e54d891cc618b2511dbe0df7 to your computer and use it in GitHub Desktop.
Save heymage/b10facd1e54d891cc618b2511dbe0df7 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. Maurice revised this gist Nov 18, 2021. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -21,6 +21,7 @@ More Examples:
    - `docs`: (changes to the documentation)
    - `style`: (formatting, missing semi colons, etc; no production code change)
    - `test`: (adding missing tests, refactoring tests; no production code change)
    - `chore`: (updating build scripts etc; no production code change)

    References:

  2. Maurice revised this gist Nov 12, 2021. 1 changed file with 7 additions and 12 deletions.
    19 changes: 7 additions & 12 deletions semantic-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,31 +1,26 @@
    # 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
    Syntax: `<type>: <summary>`

    ## Example

    ```
    feat: add hat wobble
    ^--^ ^------------^
    feat: add awesome feature
    ^--^ ^-----------------^
    | |
    | +-> Summary in present tense.
    | +-> Summary in present tense. No dot (.) at the end
    |
    +-------> Type: chore, docs, feat, fix, refactor, style, or test.
    +-------> Type: feat, fix, ref, docs, style, or test.
    ```

    More Examples:

    - `feat`: (new feature for the user, not a new feature for build script)
    - `feat`: (new feature for the user, not a new feature for build scripts)
    - `fix`: (bug fix for the user, not a fix to a build script)
    - `ref`: (refactoring production code, eg. renaming a variable)
    - `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)

    References:

  3. @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
  4. @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):

  5. @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
  6. @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