Commit

Commits

O padrão usado aqui na Prolog App foi fortemente inspirado nos guidelines de commit do angular.

Essa é a estrutura que seguimos para um commit:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Vamos dissecá-la:

1 — type ou categoria do commit: podem ser os mesmos utilizados para criar branches e que foram explicados acima.

2 — scope: onde a alteração foi feita. Aqui, criamos nossos próprios scopes que, na maioria dos casos, refletem o nome de uma funcionalidade.

3 — subject: um resumo do commit. Deve utilizar o imperativo, como: faz, adiciona, altera, muda e etc.

4 — body: espaço utilizado para detalhar o que foi feito. É opcional.

5 — footer: onde colocamos as PLs (códigos das tarefas no Jira) e também alguma breaking change.

Onde tem <BLANK LINE> significa que temos que deixar uma linha em branco. 🤷🏻‍♂️

Exemplo de um commit:

hotfix(cliente): Corriget texto label cliente task-1234

Perceba que o exemplo acima não possui body.

Tão importante quanto definir um padrão, é deixar ele facilmente acessível ao time. Aqui, cada um tem o seu “cheat sheet” bem resumido e colá-lo ao monitor pode ser bem eficiente.

Last updated