Processos de Desenvolvimento

Neste documento, vamos detalhar os processos essenciais para colaborar efetivamente no projeto usando o sistema de controle de versão Git.

Introdução ao Git

O Git é um sistema de controle de versão distribuído que permite que várias pessoas colaborem em um projeto, rastreiem as alterações, revertam para versões anteriores e gerenciem o desenvolvimento de software de maneira eficiente.

Git Workflow

Padronização de Branches e Commits

Branch /<n° issue>-<descrição>

feat/99-adicionar-usuario

Commit <n°issue>-<descrição>

#99 [feat]-criação rota para adicionar usuário

Obs: O simbolo # deve anteceder o número da issue para vinculação com o board.

• tipo: O tipo da tarefa, sendo uma das opções abaixo:
  • feat: Desenvolvimento de uma nova funcionalidade
  • fix: Correção de um bug na aplicação
• n° issue: O número da issue no board de issues do gitlab
• apelido: Breve descrição do escopo da user story.

Passo a passo para utilização do Git:

1. Clonar o projeto

git clone <endereço-repositorio-projeto>

2. Criando nova branch

2.1 Atualize a branch main Para garantir que o processo de desenvolvimento esteja sempre atualizado, lembre-se de executar o seguinte comando na branch develop antes de criar uma branch nova:

git pull origin main

2.2 Crie a nova branch

2.3 Nomes de branch

• Branches não devem possuir espaço no nome, substituir espaços ' ' por traços '-'

Para linkar a branch à issue, é necessário inicar o nome da branch com o id da issue. Exemplo: Dado uma issue onde o ID seja 13:

• issue 13

 git checkout -b 13-nome-branch

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

git checkout -b <nomeDaBranch>

3. Realizando commit Realize commits para salvar as alterações realizadas na sua branch.

3.1 Adicione as alterações ao commit 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>

3.2 Realize o commit 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 do commit'

4. Salve as alterações 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

5. Merge Request para a branch main 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 principal (main). Para isso é necessário abrir um Merge Request pela platafora GitLab:

5.1 Criando Merge Request A criação pode ser realizada na seção "Merge Request" do repositório em que a branch foi criada. Clique no botão Merge Request e seiga os passos abaixo:

1. Selecionar a branch de origem (sua branch de desenvolvimento);
2. Selecionar a branch de destino (branch main);
3. Em Title, escreva um título que descreva a funcionalidade adicionada ou bug corrigido;
4. Em Descriptionescreva uma descrição das alterações realizadas.
5. 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);
6. Em Reviewer indique um membro AGES III ou IV para revisar as alterações propostas.
7. Em Milestone selecione a Sprint em que a tarefa foi realizada;
8. Em Merge options, marque a opção 'Delete source branch when merge request is accepted'
9. Por fim, revise se todos os arquivos estão corretos, e clique em Create Merge Request.