Git Patterns

Padrões de Commits e Fluxos para Repositórios Git

O repositório visa introduzir os padrões de forma sucinta. Para abordagens completas se deve procurar as documentações oficiais.

🌍 Translations

• English
• Português Brasileiro

Conventional Commits

O desenvolvimento utilizando Git é comum para qualquer desenvolvedor, como também a falta de padrões para commits.

Para manter um padrão conciso o Conventional Commits sugere o modelo:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Os significados de cada elemento são:

type: Caracteriza a natureza da mudança. Tem como valores padrões:

Tipo	Emoji	Descrição	Exemplo
feat	✨ :sparkles:	Nova funcionalidade	Nova função, serviço ou endpoint
fix	🐛 :bug:	Correções de erros	Ajuste de bugs
docs	📚 :books:	Atualização de documentação	README, Swagger
style	🎨 :art:	Mudanças não funcionais do sistema	Remover comentários ou espaços, mudar style-guide
refactor	♻️ :recycle:	Refatoração sem impacto ao sistema	Mudanças de código após um code review
perf	⚡ :zap:	Ajuste de performance	Remover loops dispensáveis, otimizar query do banco
test	✅ :white_check_mark:	Criação ou alteração de testes	Criar uma nova suite, alterar um teste existente
build	📦 :package:	Mudanças no processo de build	Webpack, Vite, Grunt, alterar dependências
ci	💚 :green_heart:	Mudanças no processo de CI/CD	Circle, Travis, Github Actions, Jekins
chore	🔧 :wrench:	Ajustes em arquivos de configuração	.gitignore, .prettierrc, .nvm
docker	🐳 :whale:	Alteração no ambiente Docker	Criar um Dockerfile, ajustar o Docker Compose
revert	⏪ :rewind:	Reversão de um commit	-

scope: Contextualiza o commit, podendo informar branches, arquivos ou funções.

description: Descrição curta do commit. É recomendado utilizar o imperativo ao invés do pretérito. O commit deve descrever o que fará caso aplicado, dessa forma a expressão - Caso aplicado irá criar dashboard de casos - descreve melhor que - Caso aplicado irá criação de dashboard de casos.

body: Descrição longa do commit. Contextualiza de forma detalhada o description.

footer: Rodapé do commit, normalmente informa uma BREAKING CHANGE em concordância com o SemVer. O objetivo é alertar e descrever a incompatibilidade com a versão anterior. Caso não haja uma BREAKING CHANGE, ainda se pode informar usando outra convenção, como git trailer.

⚠️ Também é possível utilizar emoji nos outros elementos além do type, para uma descrição mais específica. É possível conferir a lista completa em GitMoji

Exemplos:

• Commit simples

docs: correct spelling of CHANGELOG

• Commit com scope and emoji

:sparkles: feat(lang): add Polish language

• Commit com body

fix: prevent racing of requests

Introduce a request id and a reference to latest request.
Dismiss incoming responses other than from latest request.

• Commit com footer BREAKING CHANGE e emoji

:sparkles: feat: allow provided config object to extend other configs

:boom: BREAKING CHANGE: `extends` key in config file is now used for extending other config files

• Commit com footer

refactor: change createUser() logs

Reviewed-by: Admin
Refs: #123

Commitlint & Commitizen

Para facilitar a adoção do Conventional Commits, se sugere utilizar o Commitlint ou Commitizen. Eles fornecem uma CLI que auxilia a aderência da convenção.

Git Flow

O Git Flow é um modelo de ramificação que proporciona maior controle sobre o código fonte.

O modelo sugere o seguinte fluxo:

No fluxo é descrito as seguintes branches:

main: Possui o código de produção e permanece viva durante todo o fluxo. Não pode ser modificada diretamente.

hotfix: Tem como objetivo ajustar erros em produção. Se origina com base na main.

develop: Possui o código de desenvolvimento e permanece viva durante todo o fluxo.

feature: Tem como objetivo a criação de novas funcionalidades. Se origina com base na develop.

release: Serve como intermediária entre develop e main. O objetivo é proporcionar um ambiente de homologação, onde validam as novas funcionalidades da develop para serem mescladas na main.

Para facilitar a implementação do fluxo o Git Flow disponibiliza a Git Flow CLI.

Github Flow

O Git Flow se torna complexo ao ser aplicado em pequenos times. Nesses casos é recomendável a adoção do Github Flow.

O modelo possui o seguinte fluxo:

O fluxo possui apenas uma branch (main).

Com base na main são criadas outras branches, como feat e fix.

A nova branch ao ser finalizada será excluída e terá seu código mesclado na main.

🔗 Referências

• Conventional Commits
• Medium - Conventional Commits Pattern
• Commitlint
• Commitizen
• Semantic Versioning
• Cheatsheet Git Flow
• Git Flow Atlassian
• Github Flow
• Semantic Commit Messages with Emojis
• Git Commit Emoji
• GitMoji

❤️ Autores

• @chrissgon