├── .github └── workflows │ └── label.yml ├── LICENSE ├── README-pt_BR.md ├── README.md ├── SECURITY.md ├── _config.yml └── images ├── android-chrome-192x192.png ├── android-chrome-512x512.png ├── apple-touch-icon.png ├── favicon-16x16.png ├── favicon-32x32.png └── favicon.ico /.github/workflows/label.yml: -------------------------------------------------------------------------------- 1 | # This workflow will triage pull requests and apply a label based on the 2 | # paths that are modified in the pull request. 3 | # 4 | # To use this workflow, you will need to set up a .github/labeler.yml 5 | # file with configuration. For more information, see: 6 | # https://github.com/actions/labeler/blob/master/README.md 7 | 8 | name: Labeler 9 | on: [pull_request] 10 | 11 | jobs: 12 | label: 13 | 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - uses: actions/labeler@v2 18 | with: 19 | repo-token: "${{ secrets.GITHUB_TOKEN }}" 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Dev Brotherhood 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README-pt_BR.md: -------------------------------------------------------------------------------- 1 | Commit Messages Convention (CMC) 2 | === 3 | 4 | O Commit Messages Convention (CMC) foi desenvolvido para oferecer suporte a projetos **GIT** ou **SVN** para que haja maior organização dos _commits_ no repositório. 5 | Ela define que a inserção de comentários deve ser precedido pelos tipos de ações que foram executadas nos arquivos versionados. 6 | Dessa maneira o versionamento de código-fonte fica mais flexível e coeso, facilitando a identificação do que foi realizado. 7 | Esta convenção segue o [SemVer](http://semver.org/), descrevendo os recursos, correções e modificações que quebram a compatibilidade nas mensagens de _commit_. 8 | 9 | ## Especificação 10 | As palavras-chaves "MUST" (DEVE), "MUST NOT" (NÃO DEVE), "REQUIRED" (OBRIGATÓRIO), "SHALL" (DEVERÁ), "SHALL NOT" (NÃO DEVERÁ), "SHOULD" (PODEM), "SHOULD NOT" (NÃO PODEM), "RECOMMENDED" (RECOMENDADO), "MAY" (PODE) e "OPTIONAL" (OPCIONAL), nesse documento, devem ser interpretados como descrito na [RFC 2119](http://tools.ietf.org/html/rfc2119). 11 | 12 | ## Como utilizar 13 | 14 | Como padrão, cada tipo DEVE ser colocado com letra maiúscula, entre colchetes, precedendo o que foi realizado de forma clara e objetiva durante o versionamento do código. 15 | 16 | A mensagem de _commit_ DEVE ser estruturada da seguinte forma: 17 | 18 | ``` 19 | [TIPO obrigatório] 20 | --linha em branco-- 21 | 22 | --linha em branco-- 23 | 24 | ``` 25 | ##### A mensagen: 26 | - DEVE iniciar com um [TIPO] 27 | - O [TIPO] DEVE ser com letras maiúsculas, entre colchetes, seguido por um espaço 28 | - DEVE conter uma apos o [TIPO] 29 | - PODE conter um e/ou 30 | - DEVE conter uma --linha em branco-- apos a caso tenha 31 | - DEVE conter uma --linha em branco-- apos a caso tenha 32 | 33 | ### Tipos 34 | 35 | Os tipos abaixo representam opções que podem ser usadas no início de cada _commit_. 36 | 37 | | Tipo | Descrição | 38 | |:-: | :-: | 39 | |[FEAT] | Quando um novo recurso foi desenvolvido | 40 | |[FIX] | Quando um recurso/bug foi corrigido | 41 | |[UPDATE] | Quando arquivos estáticos foram renomeados, removidos, movidos de um diretório para outro, adicionados ou substituídos | 42 | |[REFACTOR] | Quando uma alteração de código que não corrige um bug nem adiciona um recurso | 43 | |[DOCS] | Somente alterações na documentação | 44 | 45 | ### Tipos especiais 46 | 47 | É RECOMENDADO que os tipos especiais sejam utilizados em conjunto com os tipos anteriores, porem, eles PODEM ser usados em qualquer parte da mensagem. 48 | 49 | | Tipo | Descrição | 50 | |:-: | :-: | 51 | |[WIP] | Quando um desenvolvimento ainda esta em progresso | 52 | |[BREAKING] ou [BREAKING CHANGE] | Quando o _commit_ inclui uma modificação que quebra a compatibilidade. PODE ser usado em qualquer parte do _commit_ (, ou ) | 53 | 54 | #### Exemplos: 55 | ``` 56 | [FEAT][WIP] Introduz um novo método de pagamento 57 | ``` 58 | ``` 59 | [FIX][BREAKING] Substitui o gateway do PagSeguro por PayPal 60 | ``` 61 | 62 | ### Descrição 63 | 64 | Para a mensagem de e do do _commit_, faz-se o uso do padrao ["Commit Message Guide"](https://github.com/RomuloOliveira/commit-messages-guide/blob/master/README_pt-BR.md) do @RomuloOliveira, que basicamente consiste em: 65 | - **Usar o imperativo**: A mensagem de _commit_ diz o que ele faz, não o que foi **feito**. 66 | - **Primeira letra em maiúsculo**: porque é assim que se começa uma frase em qualquer texto. 67 | - **Tente comunicar o que o _commit_ faz sem que seja necessário olhar o conteúdo do _commit_.** 68 | 69 | ### Corpo 70 | 71 | - **Use o corpo da mensagem para explicar "porquê", "para quê", "como" e detalhes adicionais.** 72 | - **Evite _commits_ com mensagens genéricas ou sem contexto algum.** 73 | - **Tente limitar o nº de colunas das mensagens:** Recomenda-se 50 caracteres para a e por volta de 72 para o . 74 | - **Mantenha consistência de idioma:** Escolha um idioma e mantenha-se nele. 75 | 76 | ### Rodapé 77 | 78 | Um de uma ou mais linhas PODE ser fornecido depois de uma --linha em branco-- após o . 79 | O DEVE conter informações adicionais sobre o _commit_, por exemplo, numero da issue/task, pull-requests, revisores, modificações que quebram a compatibilidade, com uma informação adicional por linha. 80 | 81 | ## Exemplos 82 | ``` 83 | [FIX] Corrige a chamada do método "getProducts" 84 | 85 | O retorno esperado do método "getProducts" era um array, porem retornava um objeto, isso causava um erro em produção. 86 | 87 | Corrige a issue #92 88 | ``` 89 | 90 | ``` 91 | [FEAT][WIP] Cria a classe PayPalGateway 92 | 93 | Cria a estrutura base da integração com PayPal, assim como a interface de Gateway para uso futuro. 94 | ``` 95 | 96 | ``` 97 | [REFACTOR] Refatora a classe PagSeguro 98 | 99 | Reescrita da class PagSeguroGateway, para se adequar ao padrao da interface Gateway. 100 | [BREAKING CHANGE] Como a classe PagSeguroGateway foi refatorada, todos os método também foram modificados. 101 | 102 | Depende do commit sd5f54s 103 | ``` 104 | 105 | ``` 106 | [UPDATE] Adiciona os arquivos CSS e images 107 | 108 | Adiciona os arquivos que estavam faltando no diretório assets/ 109 | ``` 110 | 111 | ## Idiomas 112 | - [EN](./README.md) 113 | 114 | ## Referências 115 | - [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) 116 | - [Conventional Commits](https://www.conventionalcommits.org/pt-br/) 117 | - [Commit Messages Guide](https://github.com/RomuloOliveira/commit-messages-guide) 118 | - [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) 119 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![thumb-image](./images/android-chrome-192x192.png) 2 | 3 | Commit Messages Convention (CMC) 4 | === 5 | 6 | Commit Messages Convention (CMC) is designed to help **GIT** or **SVN** projects to a better organization of commits in the repository. 7 | It defines that commenting must be preceded by the types of actions that were performed on versioned files. 8 | This makes source code versioning more flexible and cohesive, making it easier to identify what has been done. 9 | 10 | This convention follows [SemVer](http://semver.org/), describing features, fixes, and modifications that break compatibility in commit messages. 11 | 12 | ## Specification 13 | The keywords `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY` and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119). 14 | 15 | ## How to use 16 | By default, each type MUST be capitalized, in brackets, preceding what was done clearly and objectively during code versioning. 17 | 18 | The commit message MUST be structured as follows: 19 | 20 | ``` 21 | [TYPE required] 22 | --blank line-- 23 | 24 | --blank line-- 25 | 26 | ``` 27 | ##### The message: 28 | - MUST start with a `[TYPE]` 29 | - `[TYPE]` MUST be uppercase, enclosed in brackets, followed by a space 30 | - MUST contain a `` after `[TYPE]` 31 | - MAY contain `` and/or `