Esta seção é dedicada a apresentar o processo de desenvolvimento do time, junto dela serão
apresentados documentos referentes a maneira como o time se organizou e trabalha.

♾️ Git Flow

Git_Flow_e_Boas_Práticas_de_Branching.pdf

Para mantermos os repositórios organizados, utilizaremos o Gitflow, que é um modelo alternativo de ramificação do Git que consiste no uso de ramificações de recursos (feature) ou consertos (fix ou hotfix) a partir de duas branches primárias (Main e Dev).

• Main: A branch principal, tendo todo o código final, validado e testado;
• Development: A branch de desenvolvimento (dev), onde irá organizar os trabalhos realizados.

Mais sobre o Git Workflow

🛠️ Padrões Utilizados

Idioma padrão

Todas as branches, commits e merge requests devem ser nomeados e descritos em português.

🔱 Branches

Cada branch relacionada a features/hotfixes será criada a partir da branch development.

Nomes:

Como padrão para nomes de branches, foi decidido que usaremos o CamelCase:

<tipoDeItem>/<nomeDaTask>

Exemplo:

feat/botaoDeSalvar

Criação:

Para garantir que o processo de desenvolvimento esteja sempre atualizado, lembre-se de executar o seguinte comando na branch development (dev) antes de criar uma branch nova:

git checkout dev # Troca para a branch de desenvolvimento

git pull origin dev # Atualiza a branch dev para a versão mais recente

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

git checkout -b <nomeDaBranch> # Cria uma nova branch.

# 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.

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

git add <nomeDoArquivo> # Adiciona os arquivos alterados ou criados ao 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 da tarefa em português' # Salva localmente as alterações com uma descrição obrigatória
# Para commits onde teve participação de mais de um autor. Siga o exemplo abaixo:

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

Co-Authored-By: Nome Sobrenome <[email protected]>
# Dê dois break lines (Shift + enter) e coloque nome e sobrenome do co-autor e email COM <>
# Para mais Co-autores, coloque em novas linhas

Em seguida, não esqueça de dar um push para salvar remotamente.

git push

Tipos de Commit:

• "feat", para descrever funcionalidades adicionadas;
• "fix", para descrever soluções de problemas;
• "docs", para identificar trabalho na documentação do projeto;

Exemplos de uso:

• feat: Implementation of the input button.
• fix: Correcting the submission of information to the database.
• `docs: Describe commit patterns.

〽️ Merge Requests

Um merge request (MR) deve ser criado somente quando a tarefa estiver concluída.

Criação:

A criação pode ser realizada na seção Merge Requests do repositório em que a branch foi criada. Clicando no botão New Merge Request siga os seguintes passos:

1. Selecionar a branch de origem (sua branch de desenvolvimento);
2. Selecionar a branch de destino (branch dev);
3. Selecione Compare branches and continue;
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. Caso a tarefa seja visual (criação de componente/tela, correção de bug) adicione um gif exemplificando o uso (se considerar necessário);
7. 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);
8. Em Milestone selecione a Sprint em que a tarefa foi realizada;
9. Em Labels selecione qual é o tipo de tarefa que foi realizada;
10. Por último, revise se os arquivos que estão sendo enviados estão corretos e clique em Submit Merge Request.