DevCia / Commit Style Guide
📝 Padrão de commit para repositórios com título e corpo.
Stars: ✭ 45
Projects that are alternatives of or similar to Commit Style Guide
awesome-git-commands
🍴 Indispensable git commands for everyday use
Stars: ✭ 53 (+17.78%)
Mutual labels: commit
conventional-commits
A PHP library for creating and validating commit messages according to the Conventional Commits specification. Includes a CaptainHook plugin!
Stars: ✭ 128 (+184.44%)
Mutual labels: commit
Conventionalcommits.org
The conventional commits specification
Stars: ✭ 3,552 (+7793.33%)
Mutual labels: commit
Styleguide Git Commit Message
/sBin/StyleGuide/Git/CommitMessage
Stars: ✭ 934 (+1975.56%)
Mutual labels: commit
git-commiter
📖✨ Allows you to commit following custom rules or conventions easily
Stars: ✭ 17 (-62.22%)
Mutual labels: commit
Committia.vim
A Vim plugin for more pleasant editing on commit messages
Stars: ✭ 510 (+1033.33%)
Mutual labels: commit
Git Fame
Pretty-print `git` repository collaborators sorted by contributions.
Stars: ✭ 272 (+504.44%)
Mutual labels: commit
auto-commit-msg
A VS Code extension to generate a smart commit message based on file changes
Stars: ✭ 61 (+35.56%)
Mutual labels: commit
fake commit
A git fake commit generator to make those github squares green
Stars: ✭ 17 (-62.22%)
Mutual labels: commit
Bump
Bump updates the project's version, updates/creates the changelog, makes the bump commit, tags the bump commit and makes the release to GitHub. Opinionated but configurable.
Stars: ✭ 327 (+626.67%)
Mutual labels: commit
📄 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 "📝 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 "📝 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 | 🎉 🎉
|
Version tag | 🔖 🔖
|
New feature | ✨ ✨
|
Bugfix | 🐛 🐛
|
Metadata | 📇 📇
|
Documentation | 📚 📚
|
Documenting source code | 💡 💡
|
Performance | 🐎 🐎
|
Cosmetic | 💄 💄
|
Tests | 🚨 🚨
|
Adding a test | ✅ ✅
|
Make a test pass | ✔️ ✔️
|
General update | ⚡️ ⚡️
|
Improve format/structure | 🎨 🎨
|
Refactor code | 🔨 🔨
|
Removing code/files | 🔥 🔥
|
Continuous Integration | 💚 💚
|
Security | 🔒 🔒
|
Upgrading dependencies | ⬆️ ⬆️
|
Downgrading dependencies | ⬇️ ⬇️
|
Lint | 👕 👕
|
Translation | 👽 👽
|
Text | 📝 📝
|
Critical hotfix | 🚑 🚑
|
Deploying stuff | 🚀 🚀
|
Fixing on MacOS | 🍎 🍎
|
Fixing on Linux | 🐧 🐧
|
Fixing on Windows | 🏁 🏁
|
Work in progress | 🚧 🚧
|
Adding CI build system | 👷 👷
|
Analytics or tracking code | 📈 📈
|
Removing a dependency | ➖ ➖
|
Adding a dependency | ➕ ➕
|
Docker | 🐳 🐳
|
Configuration files | 🔧 🔧
|
Package.json in JS | 📦 📦
|
Merging branches | 🔀 🔀
|
Bad code / need improv. | 💩 💩
|
Reverting changes | ⏪ ⏪
|
Breaking changes | 💥 💥
|
Code review changes | 👌 👌
|
Accessibility | ♿️ ♿️
|
Move/rename repository | 🚚 🚚
|
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.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].