├── LICENSE.md
├── CONTRIBUTING.md
└── README.md
/LICENSE.md:
--------------------------------------------------------------------------------
1 | #### Copyright © 2021 / [Iuri Silva](https://github.com/iuricode)
2 |
3 | A permissão é concedida, gratuitamente, a qualquer pessoa que obtenha uma cópia deste arquivo, sem restrição nos direitos de usar, copiar, modificar e mesclar.
4 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Como contribuir?
2 |
3 | Este é um projeto totalmente livre que aceita contribuições via pull requests no GitHub. Este documento tem a responsabilidade de alinhar as contribuições de acordo com os padrões estabelecidos no mesmo. Em caso de dúvidas, [abra uma issue](https://github.com/iuricode/padroes-de-commits/issues/new).
4 |
5 | ## Passos
6 |
7 | 1. Crie um fork deste repositório.
8 | 2. Envie seus commits em português.
9 | 3. Insira um pequeno resumo sobre o que foi adicionado.
10 | 4. Solicite um pull request.
11 |
12 | ## Recomendação (opcional)
13 |
14 | Para uma melhor semântica nos commits, recomendamos utilizar os commits mencionados neste projeto open source. Assim ficará mais fácil para avaliar seu pull request.
15 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Padrões de commits 📜
2 |
3 | De acordo com a documentação do **[Conventional Commits](https://www.conventionalcommits.org/pt-br)**, commits semânticos são uma convenção simples para ser utilizada nas mensagens de commit. Essa convenção define um conjunto de regras para criar um histórico de commit explícito, o que facilita a criação de ferramentas automatizadas.
4 |
5 | Esses commits auxiliarão você e sua equipe a entenderem de forma facilitada quais alterações foram realizadas no trecho de código que foi commitado.
6 |
7 | Essa identificação ocorre por meio de uma palavra e emoji que identifica se aquele commit realizado se trata de uma alteração de código, atualização de pacotes, documentação, alteração de visual, teste...
8 |
9 | ## Tipo e descrição 🦄
10 |
11 | O commit semântico possui os elementos estruturais abaixo (tipos), que informam a intenção do seu commit ao utilizador(a) de seu código.
12 |
13 | - `feat`- Commits do tipo feat indicam que seu trecho de código está incluindo um **novo recurso** (se relaciona com o MINOR do versionamento semântico).
14 |
15 | - `fix` - Commits do tipo fix indicam que seu trecho de código commitado está **solucionando um problema** (bug fix), (se relaciona com o PATCH do versionamento semântico).
16 |
17 | - `docs` - Commits do tipo docs indicam que houveram **mudanças na documentação**, como por exemplo no Readme do seu repositório. (Não inclui alterações em código).
18 |
19 | - `test` - Commits do tipo test são utilizados quando são realizadas **alterações em testes**, seja criando, alterando ou excluindo testes unitários. (Não inclui alterações em código)
20 |
21 | - `build` - Commits do tipo build são utilizados quando são realizadas modificações em **arquivos de build e dependências**.
22 |
23 | - `perf` - Commits do tipo perf servem para identificar quaisquer alterações de código que estejam relacionadas a **performance**.
24 |
25 | - `style` - Commits do tipo style indicam que houveram alterações referentes a **formatações de código**, semicolons, trailing spaces, lint... (Não inclui alterações em código).
26 |
27 | - `refactor` - Commits do tipo refactor referem-se a mudanças devido a **refatorações que não alterem sua funcionalidade**, como por exemplo, uma alteração no formato como é processada determinada parte da tela, mas que manteve a mesma funcionalidade, ou melhorias de performance devido a um code review.
28 |
29 | - `chore` - Commits do tipo chore indicam **atualizações de tarefas** de build, configurações de administrador, pacotes... como por exemplo adicionar um pacote no gitignore. (Não inclui alterações em código)
30 |
31 | - `ci` - Commits do tipo ci indicam mudanças relacionadas a **integração contínua** (_continuous integration_).
32 |
33 | - `raw` - Commits to tipo raw indicam mudanças relacionadas a arquivos de configurações, dados, features, parametros.
34 |
35 | ## Recomendações 🎉
36 |
37 | - Adicione um tipo consistente com o título do conteúdo.
38 | - Recomendamos que na primeira linha deve ter no máximo 4 palavras.
39 | - Para descrever com detalhes, usar a descrição do commit.
40 | - Usar um emoji no início da mensagem de commit representando sobre o commit.
41 | - Os links precisam ser adicionados em sua forma mais autêntica, ou seja: sem encurtadores de link e links afiliados.
42 |
43 | ## Complementos de commits 💻
44 |
45 | - **Rodapé:** informação sobre o revisor e número do card no Trello ou Jira. Exemplo: Reviewed-by: Elisandro Mello Refs #133
46 | - **Corpo:** descrições mais precisas do que está contido no commit, apresentando impactos e os motivos pelos quais foram empregadas as alterações no código, como também instruções essenciais para intervenções futuras. Exemplo: see the issue for details on typos fixed.
47 | - **Descrições:** uma descrição sucinta da mudança. Exemplo: correct minor typos in code
48 |
49 | ## Padrões de emojis 💈
50 |
51 |
52 |
53 |
54 | | Tipo do commit |
55 | Emoji |
56 | Palavra-chave |
57 |
58 |
59 |
60 |
61 | | Acessibilidade |
62 | ♿ :wheelchair: |
63 | |
64 |
65 |
66 | | Adicionando um teste |
67 | ✅ :white_check_mark: |
68 | test |
69 |
70 |
71 | | Adicionando uma dependência |
72 | ➕ :heavy_plus_sign: |
73 | build |
74 |
75 |
76 | | Alterações de revisão de código |
77 | 👌 :ok_hand: |
78 | style |
79 |
80 |
81 | | Animações e transições |
82 | 💫 :dizzy: |
83 | |
84 |
85 |
86 | | Bugfix |
87 | 🐛 :bug: |
88 | fix |
89 |
90 |
91 | | Comentários |
92 | 💡 :bulb: |
93 | docs |
94 |
95 |
96 | | Commit inicial |
97 | 🎉 :tada: |
98 | init |
99 |
100 |
101 | | Configuração |
102 | 🔧 :wrench: |
103 | chore |
104 |
105 |
106 | | Deploy |
107 | 🚀 :rocket: |
108 | |
109 |
110 |
111 | | Documentação |
112 | 📚 :books: |
113 | docs |
114 |
115 |
116 | | Em progresso |
117 | 🚧 :construction: |
118 | |
119 |
120 |
121 | | Estilização de interface |
122 | 💄 :lipstick: |
123 | feat |
124 |
125 |
126 | | Infraestrutura |
127 | 🧱 :bricks: |
128 | ci |
129 |
130 |
131 | | Lista de ideias (tasks) |
132 | 🔜 :soon: |
133 | |
134 |
135 |
136 | | Mover/Renomear |
137 | 🚚 :truck: |
138 | chore |
139 |
140 |
141 | | Novo recurso |
142 | ✨ :sparkles: |
143 | feat |
144 |
145 |
146 | | Package.json em JS |
147 | 📦 :package: |
148 | build |
149 |
150 |
151 | | Performance |
152 | ⚡ :zap: |
153 | perf |
154 |
155 |
156 | | Refatoração |
157 | ♻️ :recycle: |
158 | refactor |
159 |
160 |
161 | | Removendo um arquivo |
162 | 🔥 :fire: |
163 | |
164 |
165 |
166 | | Removendo uma dependência |
167 | ➖ :heavy_minus_sign: |
168 | build |
169 |
170 |
171 | | Responsividade |
172 | 📱 :iphone: |
173 | |
174 |
175 |
176 | | Revertendo mudanças |
177 | 💥 :boom: |
178 | fix |
179 |
180 |
181 | | Segurança |
182 | 🔒️ :lock: |
183 | |
184 |
185 |
186 | | SEO |
187 | 🔍️ :mag: |
188 | |
189 |
190 |
191 | | Tag de versão |
192 | 🔖 :bookmark: |
193 | |
194 |
195 |
196 | | Teste de aprovação |
197 | ✔️ :heavy_check_mark: |
198 | test |
199 |
200 |
201 | | Testes |
202 | 🧪 :test_tube: |
203 | test |
204 |
205 |
206 | | Texto |
207 | 📝 :pencil: |
208 | |
209 |
210 |
211 | | Tipagem |
212 | 🏷️ :label: |
213 | |
214 |
215 |
216 | | Tratamento de erros |
217 | 🥅 :goal_net: |
218 | |
219 |
220 |
221 | | Dados |
222 | 🗃️ :card_file_box: |
223 | raw |
224 |
225 |
226 |
227 |
228 | ## 💻 Exemplos
229 |
230 |
231 |
232 |
233 | | Comando Git |
234 | Resultado no GitHub |
235 |
236 |
237 |
238 |
239 |
240 | git commit -m ":tada: Commit inicial"
241 | |
242 | 🎉 Commit inicial |
243 |
244 |
245 |
246 | git commit -m ":books: docs: Atualização do README"
247 | |
248 | 📚 docs: Atualização do README |
249 |
250 |
251 |
252 | git commit -m ":bug: fix: Loop infinito na linha 50"
253 | |
254 | 🐛 fix: Loop infinito na linha 50 |
255 |
256 |
257 |
258 | git commit -m ":sparkles: feat: Página de login"
259 | |
260 | ✨ feat: Página de login |
261 |
262 |
263 |
264 | git commit -m ":bricks: ci: Modificação no Dockerfile"
265 | |
266 | 🧱 ci: Modificação no Dockerfile |
267 |
268 |
269 |
270 | git commit -m ":recycle: refactor: Passando para arrow functions"
271 | |
272 | ♻️ refactor: Passando para arrow functions |
273 |
274 |
275 |
276 | git commit -m ":zap: perf: Melhoria no tempo de resposta"
277 | |
278 | ⚡ perf: Melhoria no tempo de resposta |
279 |
280 |
281 |
282 | git commit -m ":boom: fix: Revertendo mudanças ineficientes"
283 | |
284 | 💥 fix: Revertendo mudanças ineficientes |
285 |
286 |
287 |
288 | git commit -m ":lipstick: feat: Estilização CSS do formulário"
289 | |
290 | 💄 feat: Estilização CSS do formulário |
291 |
292 |
293 |
294 | git commit -m ":test_tube: test: Criando novo teste"
295 | |
296 | 🧪 test: Criando novo teste |
297 |
298 |
299 |
300 | git commit -m ":bulb: docs: Comentários sobre a função LoremIpsum( )"
301 | |
302 | 💡 docs: Comentários sobre a função LoremIpsum( ) |
303 |
304 |
305 |
306 | git commit -m ":bulb: raw: RAW Data do ano aaaa"
307 | |
308 | 🗃️ raw: RAW Data do ano aaaa |
309 |
310 |
311 |
312 |
313 | ## Contribuição ✨
314 |
315 | Ajude a comunidade tornando este projeto ainda mais incrível. Leia como contribuir clicando **[aqui](https://github.com/iuricode/padroes-de-commits/blob/main/CONTRIBUTING.md)** e a **[licença](https://github.com/iuricode/padroes-de-commits/blob/main/LICENSE.md)**. Estou convencido de que juntos alcançaremos coisas incríveis!
316 |
317 | ## Aprenda desenvolvimento frontend ❤️
318 |
319 | Este repositório é um projeto gratuito para a comunidade de desenvolvedores, mas você pode me ajudar comprando o meu ebook "**[eFront - Estudando frontend do zero](https://iuricode.com/efront)**" se estiver interessado em aprender ou melhorar suas habilidades de desenvolvimento frontend. A sua compra me ajuda a produzir e fornecer mais conteúdo gratuito para a comunidade. Adquira agora e comece sua jornada no desenvolvimento frontend.
320 |
--------------------------------------------------------------------------------