Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save albertpark/00f367483f32b54ad662948ebe1f5bfd to your computer and use it in GitHub Desktop.
Save albertpark/00f367483f32b54ad662948ebe1f5bfd to your computer and use it in GitHub Desktop.

Revisions

  1. albertpark revised this gist May 14, 2020. 1 changed file with 15 additions and 7 deletions.
    22 changes: 15 additions & 7 deletions semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -19,13 +19,21 @@ feat: add hat wobble

    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)
    * `feat` - A new feature for the user, not a new feature for the build script
    * `fix` - A bug fix for the user, not a fix to a build script
    * `docs` - Changes to the documentation
    * `style` - Code formatting, white-space, missing semi-colons, etc; no production code change
    * `refactor` - A code change that neither fixes a bug nor adds a feature, eg. renaming a variable
    * `test` - Adding missing tests or correcting existing tests
    * `chore` - Other changes that don't modify src or test files

    Extras:

    * `perf` - A code change that improves performance or optimizes
    * `build` - Changes that affect the build system or external dependencies, eg. gulp, broccoli, npm
    * `ci` - Changes to our CI configuration files and scripts, eg. Travis, Circle, BrowserStack, SauceLabs
    * `revert` - Change back to the previous commit
    * `license` - Edits regarding licensing, no production code change

    References:

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

  4. @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
    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
  5. @joshbuchea joshbuchea created this gist May 15, 2017.
    13 changes: 13 additions & 0 deletions semantic-commit-messages.md
    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