iuricode /padroes-de-commits

Padrões de commits

★ 9,756⑂ 1,401👁 86⑃ 40● 12▤ 0
ShellMITCreated 2021-01-06
-3
日增长
9,756
stars
1,401
forks
86
watchers
40
prs
12
issues
0
releases

README

Padrões de commits 📜

De acordo com a documentação do Conventional Commits, 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.

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.

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...

 Índice 🧭

- Formato da mensagem
- Tipo e descrição
- Validando commits com o hook commit-msg
- Recomendações
- Complementos de commits
- Padrões de emojis
- Exemplos
- Principais comandos do Git
- Glossário
- Contribuição

 Formato da mensagem 🧩

text
:emoji: tipo(escopo opcional): descrição


- :emoji: - Representa o commit visualmente (veja a tabela de emojis). É recomendado, mas o hook aceita a mensagem sem ele. Pode ser o código (:sparkles:) ou o próprio emoji (✨).
- tipo - Um dos tipos abaixo, como feat ou fix.
- (escopo) - Opcional. Indica a área afetada, como em feat(auth): ....
- ! - Opcional. Indica uma mudança que quebra a compatibilidade (_breaking change_), como em feat(api)!: ....
- descrição - Resumo curto do que foi feito.

Exemplo: :sparkles: feat(auth): adicionar página de login

 Tipo e descrição 🦄

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.

- 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).

- 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).

- docs - Commits do tipo docs indicam que houve mudanças na documentação, como por exemplo no Readme do seu repositório. (Não inclui alterações em código).

- 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)

- build - Commits do tipo build são utilizados quando são realizadas modificações em arquivos de build e dependências.

- perf - Commits do tipo perf servem para identificar quaisquer alterações de código que estejam relacionadas a performance.

- style - Commits do tipo style indicam que houve alterações referentes a formatações de código, semicolons, trailing spaces, lint... (Não inclui alterações em código).

- 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 funcionalidad

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON