|
|
A presente página descreve a padronização que será utilizada no versionamento dentro do projeto, para facilitar a leitura e organização do que foi realizado pela equipe.
|
|
|
|
|
|
## Nomenclatura de *Branches*
|
|
|
|
|
|
Para padronização, as *branches* deverão ser criadas a partir do seguinte modelo:
|
|
|
|
|
|
Número da tarefa / nome da tarefa (separado com hífen)
|
|
|
|
|
|
Lembre-se de antes da criação da nova branch, ir para a branch **dev** e rodar um `git pull`para garantir que esteja tudo atualizado. Após isso, execute o comando para criação de branch, como, por exemplo, `git checkout -b "nome da sua branch"`. Então, com a branch criada, para torná-la visível ao resto da equipe, utilize o `git push --set-upstream origin "nome da sua branch"` para enviá-la ao repositório remoto.
|
|
|
|
|
|
## Padronização dos Commits
|
|
|
|
|
|
Para uma maior organização, os commits devem seguir o padrão:
|
|
|
|
|
|
Tipo do commit: Nome dos autores
|
|
|
Descrição do que foi feito no commit.
|
|
|
|
|
|
|
|
|
Sendo que o tipo de commit pode ser:
|
|
|
- Fix, para uma correção de algo;
|
|
|
- Feature, para algo novo criado;
|
|
|
- Rollback, para caso seja necessário reverter algo;
|
|
|
- Update, para uma atualização em alguma biblioteca.
|
|
|
|
|
|
Ps: Para escrever commits com mais de uma linha, pode-se utilizar `git commit -m "` e dar um enter, que contará mais de uma linha, e ao finalizar, fechar a outra ".
|
|
|
|
|
|
## Merge Requests
|
|
|
|
|
|
Quando você estiver com a sua task pronta (Precisamos ainda do *definition of done)*, você deve abrir um merge request para que a sua task vá para a branch principal, dev. Para isso, siga os seguintes passos:
|
|
|
|
|
|
- Atualize a sua branch com as mudanças da branch principal, **dev**, com o comando `git pull origin dev`;
|
|
|
- Caso existam conflitos, resolva-os;
|
|
|
- Abra o repositório (gitlab) e crie um Merge Request;
|
|
|
- Como título, coloque o nome da tarefa e descreva a tarefa em sua descrição. |