Skip to content

Instantly share code, notes, and snippets.

@jandersonTIC
Forked from joshbuchea/semantic-commit-messages.md
Last active February 24, 2023 14:49
Show Gist options
  • Save jandersonTIC/316845110c3e52be3288e218101e3225 to your computer and use it in GitHub Desktop.
Save jandersonTIC/316845110c3e52be3288e218101e3225 to your computer and use it in GitHub Desktop.

Revisions

  1. jandersonTIC revised this gist Feb 24, 2023. 1 changed file with 3 additions and 0 deletions.
    3 changes: 3 additions & 0 deletions semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -22,6 +22,9 @@ see the issue for details
    on typos fixed.
    JIRAISSUEKEY-123
    Co-authored-by: Fulana Silva <[email protected]>
    Co-authored-by: Beltrano Costa <[email protected]>
    ```

    Outra convenção importante é inserir tipos no título do commit, seja alguns tipos e seus respectivos propósitos:
  2. jandersonTIC revised this gist Feb 28, 2021. 1 changed file with 17 additions and 17 deletions.
    34 changes: 17 additions & 17 deletions semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -1,19 +1,19 @@
    # Semantic Commit Messages
    # Boas práticas para mensagens de commit no Git

    See how a minor change to your commit message style can make you a better programmer.
    Veja como pequenas alterações nas mensagens de commit no Git podem ajudar você e seu time a melhorar a legibilidade e rastreabilidade do seu código.

    Format:
    Formato:
    ```
    <type>[optional scope]: <description>
    <tipo>[escopo opcional]: <descrição>
    [optional body]
    [corpo opcional]
    [optional footer(s)]
    [rodapé opcional]
    ```

    `footer` is optional, but I recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, if you use Jira Issue Key as `footer`.
    `rodapé` é opcional, mas eu recomendo quando estiver usando Jira, porque o Jira consegue rastrear e relacionar Jira Issues com commit, branch e pull request, desde que você esteja usando a chave do Jira Issue como `footer`.

    ## Example
    ## Exemplo

    ```
    fix: correct minor typos in code
    @@ -24,17 +24,17 @@ on typos fixed.
    JIRAISSUEKEY-123
    ```

    More Type Examples:
    Outra convenção importante é inserir tipos no título do commit, seja alguns tipos e seus respectivos propósitos:

    - `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`: (nova funcionalidade para o usuário, não use quando a funcionalidade não tiver relação com o usuário, por exemplo, criar um script de build)
    - `fix`: (corrigir um bug para o usuário, não usar para correção de bugs que não aferam o usuário)
    - `docs`: (alterações em documentações)
    - `style`: (formatação, lint, esqueçeu um ponto de vírgula, etc; sem alteração de código de produção)
    - `refactor`: (refatoração de código de produção, por exemplo, renomear uma variável)
    - `test`: (adicionar testes, refatorar testes; sem alteração de código de produção)
    - `chore`: (atualização de tarefas de rotina; sem alteração de código de produção)

    References:
    Saiba mais em:

    - https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
    - https://www.conventionalcommits.org/
  3. jandersonTIC revised this gist Dec 10, 2020. 1 changed file with 0 additions and 1 deletion.
    1 change: 0 additions & 1 deletion semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -19,7 +19,6 @@ Format:
    fix: correct minor typos in code
    see the issue for details
    on typos fixed.
    JIRAISSUEKEY-123
  4. jandersonTIC revised this gist Dec 10, 2020. 1 changed file with 17 additions and 11 deletions.
    28 changes: 17 additions & 11 deletions semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -2,24 +2,30 @@

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

    Format: `<type>/<scope>: <subject>`
    Format:
    ```
    <type>[optional scope]: <description>
    [optional body]
    [optional footer(s)]
    ```

    `<scope>` is optional, but I recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, if you use Jira Issue Key as `<Scope>`.
    `footer` is optional, but I recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, if you use Jira Issue Key as `footer`.

    ## Example

    ```
    feat/ABCDEFG-123: add hat wobble
    ^--^ ^---------^ ^------------^
    | | |
    | | +-> Summary in present tense.
    | |
    | +--------------> Jira Issue Key
    |
    +-------------------> Type: chore, docs, feat, fix, refactor, style, or test.
    fix: correct minor typos in code
    see the issue for details
    on typos fixed.
    JIRAISSUEKEY-123
    ```

    More Examples:
    More Type 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)
  5. jandersonTIC revised this gist Nov 18, 2020. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -4,7 +4,7 @@ See how a minor change to your commit message style can make you a better progra

    Format: `<type>/<scope>: <subject>`

    `<scope>` is optional, but I strongly recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, automatically if you use Jira Issue Key as `<Scope>`.
    `<scope>` is optional, but I recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, if you use Jira Issue Key as `<Scope>`.

    ## Example

  6. jandersonTIC revised this gist Nov 18, 2020. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -4,7 +4,7 @@ See how a minor change to your commit message style can make you a better progra

    Format: `<type>/<scope>: <subject>`

    `<scope>` is optional, but I strongly recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, automatically if you use Jira Issue Key as <Scope>.
    `<scope>` is optional, but I strongly recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, automatically if you use Jira Issue Key as `<Scope>`.

    ## Example

  7. jandersonTIC revised this gist Nov 18, 2020. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -9,7 +9,7 @@ Format: `<type>/<scope>: <subject>`
    ## Example

    ```
    feat/PPMHOAP-841: add hat wobble
    feat/ABCDEFG-123: add hat wobble
    ^--^ ^---------^ ^------------^
    | | |
    | | +-> Summary in present tense.
  8. jandersonTIC revised this gist Nov 18, 2020. 1 changed file with 10 additions and 7 deletions.
    17 changes: 10 additions & 7 deletions semantic-commit-messages.md
    Original file line number Diff line number Diff line change
    @@ -2,19 +2,21 @@

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

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

    `<scope>` is optional
    `<scope>` is optional, but I strongly recommend when we are using Jira, because the Jira can tracking and correlate Jira Issues with commits, branches, pull requests, so on, automatically if you use Jira Issue Key as <Scope>.

    ## Example

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

    More Examples:
    @@ -29,6 +31,7 @@ More Examples:

    References:

    - https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
    - https://www.conventionalcommits.org/
    - https://seesparkbox.com/foundry/semantic_commit_messages
    - http://karma-runner.github.io/1.0/dev/git-commit-msg.html
  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
    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
    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
    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
    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