📄
Padrões de commit
O commit do cógido é uma coisa muito importante para nós desenvolvedores, por isso é sempre bom adotarmos padrões para nossos commits. Abaixo, iremos apresentar um padrão de commit com título, corpo e emoji.
🎨
Styleguide
- Utilize modo imperativo: "Adiciona feature";
- Primeira linha deve ter no máximo 72 caracteres;
- Considere descrever com detalhes no corpo do commit;
- Considere usar um emoji no início da mensagem de commit;
📝
Exemplo
git commit -m ":memo: Adiciona README
>
> Foi criado o arquivo README.md com as informações mais relevantes do repositório"
✔️
Resultado
🔥
Como fazer pelo terminal
// Adicione
$ git add .
// Faça o commit
$ git commit -m ":memo: Adiciona README
>
> Foi criado o arquivo README.md com as informações mais relevantes do repositório"
// Para realizar a quebra de linha pelo terminal, você terá que abrir aspas " e clicar enter sem fechar as aspas "
// Após finalizar o título e o corpo do commit, você pode fechar as aspas "
// Por fim, faça o push:
$ git push origin master
🚀
Padrões de emojis
Commit type | Emoji |
---|---|
Initial commit |
:tada: |
Version tag |
:bookmark: |
New feature |
:sparkles: |
Bugfix |
:bug: |
Metadata |
:card_index: |
Documentation |
:books: |
Documenting source code |
:bulb: |
Performance |
:racehorse: |
Cosmetic |
:lipstick: |
Tests |
:rotating_light: |
Adding a test |
:white_check_mark: |
Make a test pass |
:heavy_check_mark: |
General update |
:zap: |
Improve format/structure |
:art: |
Refactor code |
:hammer: |
Removing code/files |
:fire: |
Continuous Integration |
:green_heart: |
Security |
:lock: |
Upgrading dependencies |
:arrow_up: |
Downgrading dependencies |
:arrow_down: |
Lint |
:shirt: |
Translation |
:alien: |
Text |
:pencil: |
Critical hotfix |
:ambulance: |
Deploying stuff |
:rocket: |
Fixing on MacOS |
:apple: |
Fixing on Linux |
:penguin: |
Fixing on Windows |
:checkered_flag: |
Work in progress |
:construction: |
Adding CI build system |
:construction_worker: |
Analytics or tracking code |
:chart_with_upwards_trend: |
Removing a dependency |
:heavy_minus_sign: |
Adding a dependency |
:heavy_plus_sign: |
Docker |
:whale: |
Configuration files |
:wrench: |
Package.json in JS |
:package: |
Merging branches |
:twisted_rightwards_arrows: |
Bad code / need improv. |
:hankey: |
Reverting changes |
:rewind: |
Breaking changes |
:boom: |
Code review changes |
:ok_hand: |
Accessibility |
:wheelchair: |
Move/rename repository |
:truck: |
Other | Be creative |
🎓
Autores
Vitor Serrano |
Claudio Silva Junior |
---|
⚡
Agradecimentos
- Este repositório foi inspirado no styleguide para commit feito pela Cristina Silva.
- A tabela de emojis foi feita pelo François Parmentier.