Skip to content

Instantly share code, notes, and snippets.

@felipe-ssilva
Last active March 10, 2022 21:46
Show Gist options
  • Save felipe-ssilva/7f6bd5d3335520206d2f6fa306d2976e to your computer and use it in GitHub Desktop.
Save felipe-ssilva/7f6bd5d3335520206d2f6fa306d2976e to your computer and use it in GitHub Desktop.
export default 'padrao-de-commit' 👩‍💻

😉 Yes, we can! And we must!

Antes de mais nada: todo o trabalho precisa ser "commitado". Sem mais, nem menos. Esse é o primeiro passo.

♻️ Siga os padrões, amiguinho.

Não reinvente a roda e não seja rebelde. Se o projeto que você começou a trabalhar, já tem um padrão definido e que atende a necessidade, não há razão para mudanças drásticas. Se o projeto já tem tempos de vivência, significa que o padrão atual já dá conta do recado (ou ao menos deveria).

🚀 Ao infinito e além!

O ideal para manter o código bem versionado é, para cada mudança, um commit. Seja adição de nova funcionalidade, correção de bug ou até remoção de uma funcionalidade antiga. Isso nos dá a facilidade de usar uma das principais funcionalidades do versionamento: retroceder ao código antes do commit indicado.

Commit

Todo commit deve ser tratado como um verbo (ação), seguido da(s) alteração(ões) feita(s) – seja uma adicão, atualização ou remoção.

Alguns dos verbos são: add, create, update, edit, remove. Exemplos:

  git commit -m "FK-111 Create: filter and countdown"
  git commit -m "FK-124 Remove: popup in mobile"
  git commit -m "FK-112 Update: responsive menu"
  git commit -m "FK-123 Edit: links color in a submenu"
  git commit -m "FK-166 Fix: bug in flag"

Exemplo de Add: Estou resolvendo uma feature, mas preciso ir almoçar ou sair pra fazer qualquer outra coisa... Vou commitar para não perder nada, mas como sei que não terminei a task, vou dar um commit enumerado:

git commit -m "FK-010 Add: modal login #1"

Depois que tudo estiver pronto:

git commit -m "FK-010 Add: modal login #2"

Merges

A nomeclatura de um merge deve ser simples e coesa, condizendo com o motivo daquele merge. Mais específicamente, indicar a ação realizada naquele merge logo no início. Exemplos de ação: fix, add, remove, refactoring.

Obs: O ID da tarefa no início do commit, é fundamental para a integração que iremos fazer do bitbucket com o jira 😁

@mauriciodarocha
Copy link

Ótimo documento. (^^)

@anaarezo
Copy link

(Y)

@stelycavalcante
Copy link

Muito bom!

@LeoSolla
Copy link

Mestrinho! <3'

@leoprieto87
Copy link

Boa Fe!!!
E está bom de redação tabm mano.
Parabéns!!!

@joaroque
Copy link

Obrigado!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment