Processo de desenvolvimento

Esta seção é dedicada a apresentar o processo de desenvolvimento do time.

Git workflow

Branchs

Criando branch no Gitlab

1. No Gitlab, abra a Issue que você vai trabalhar.

2. Clique na seta ao lado do botão Create merge request, verifique se o nome da branch faz sentido para você, se fizer deixe o nome default, e escolha a branch (Source) que a sua branch vai ramificar, geralmente a main.

3. Clique em Create branch.

4. A branch vai estar remota, faça o fetch no seu repositório local e de checkout para ela, agora você já pode trabalhar na sua Task.

Nomes

Padrão para o nome de branchs:

NumeroDaIssue-nome-da-issue

Exemplo para o nome de branches:

18-corrigir-quando-ci-e-acionado

Criando branch local

Para garantir que o processo de desenvolvimento esteja sempre atualizado, lembre-se de voltar para a branch main e executar o seguinte comando antes de criar uma branch nova:

git checkout main

git pull origin main

Depois da execução desse comando é necessário oficialmente criar a Branch, para isso, execute o seguinte comando:

git checkout -b <nomeDaBranch>

Assim que criar a branch, é necessário fazer um push para garantir que a mesma estará remota:

git push --set-upstream origin <nomeDaBranch>

Pronto! Agora você já pode começar a programar na sua Branch.

Commits

Para que o código desenvolvido seja salvo em sua branch de maneira remota, é necessário realizar os comandos de commit e push

Salvando Localmente

Para garantir que apenas o código necessário para funcionamento da tarefa lembre-se de realizar o comando add apenas nos arquivos essenciais para a tarefa:

git add <nomeDoArquivo>

Depois de adicionar todos os arquivos que deseja salvar, execute o commando de commit com uma mensagem curta que represente o que foi trabalhado nesses arquivos adicionados:

git commit -m 'descrição da tarefa em português'

Não hesite em realizar vários commits, assim podemos ter documentado e salvo vários estados do desenvolvimento.

Salvando Remotamente

Depois de finalizar o desenvolvimento, envie todos os commits da sua máquina para o servidor remoto. Para isso depois de realizar as etapas de salvamento local, salve remotamente com o comando push:

git push

Merge Requests

Depois de uma task ter sido desenvolvida e estiver pronta de acordo com os critérios de aceitação, é necessário que a mesma seja enviada para a branch main. Para isso é necessário abrir um Merge Request pela plataforma GitLab:

Criando o Merge Request a partir da Issue

1. Abra a Issue que foi trabalhada.

2. Clique na branch relacionada com a Issue.

3. Clique em Create merge request.

4. Em Title, escreva um título que descreva a funcionalidade adicionada ou bug corrigido.

5. Em Description, escreva uma descrição com uma breve justificativa nos arquivos que foram alterados.

6. Na seção Assignee, selecione Assign to me para que fique registrado quem foi o responsável pelo desenvolvimento daquela tarefa (a pessoa selecionada será chamada caso o revisor tenha dúvidas sobre a tarefa).

7. Em Milestone selecione a Sprint em que a tarefa foi realizada.

8. Por último, revise se os arquivos que estão sendo enviados estão corretos e clique em Submit Merge Request.

Revisando o Merge Request

A revisão de merge request pode ser realizada por qualquer desenvolvedor, mas é preciso da aprovação de pelo menos um AGES III ou AGES IV para que a mesma seja incorporada na branch main.

Caso haja pendências, relacionadas a documentação do código, padronização ou arquivos enviados, não exite em realizar um novo commit na branch com as mudanças necessárias antes de realizar a integração.