Manual do fluxo de trabalho com git/gitHub na fábrica
1. Configuração inicial do Git na máquina:
Primeiro você deve abrir o Terminal em seu VS Code e utilizar os comandos $ git config --global user.name "Usuário"
e $ git config --global user.email "Email"
para colocar suas informações do gitHub.
2. Clonagem de um repositório:
Após colocar suas informações, você deve procurar o repositório do projeto que desejar, clicar em <>Code
e copiar o URL.
Após copiar o URL você deve voltar ao Terminal do VS Code e usar o comado git clone "URL"
.
Após clonar repositório, abra a pasta do projeto.
3. Criação de uma branch a partir da issue:
Dentro da pasta do projeto é muito importante lembrar de nunca modificar a MAIN.
E para isso é necessário criar uma Branch nova, uma cópia da MAIN onde não irá modificar ela.
Para criar uma nova Branch você pode utilizar o comando git checkout -b
e informa o nome da nova branch, ou Clicar em MAIN, criar nova Branch e escrever o nome , porém é muito importante colocar um nome que faça sentido (ex: feature/nome-da-tarefa
, fix/ajuste-x
), para uma melhor organização.
OBS: Lembre-se sempre de trocar para sua Branch quando for modificar o código.
4. Desenvolvimento:
Para o desenvolvimento do projeto é extremamente necessário o uso de commits frequentes e bem explicativos sobre as mudanças realizadas.
O commit serve para salvar as alterações realizadas apenas na Branch modificada, assim evitando perdas de progressos já realizados no projeto.
Para realizar um commit você pode utilizar o comando git add .
e git commit -m "informação do commit"
no Terminal, ou clique na opção de controle de mudanças e clique na opção commit
.
OBS: Lembre-se sempre de colocar uma descrição que faça sentido para manter a organização.
5.Sincronização com a branch remota:
Para sincronizar a sua Branch com a versão mais atual dela é bem simples, apenas use o comando git push -u origin nome-da-branch
no Terminal do VS Code ou aperte as setas do lado do nome da sua Branch.
6.Criação de Pull Request:
Após terminar as mudanças no projeto, você deve juntar as mudanças na MAIN, para isso você deve voltar no gitHub, entrar no repositório do projeto, escolher a sua Branch
clicar em contribute
e em Open pull request
coloque um TITULO e uma DESCRIÇÃO coerente com as mudanças feitas e então clique em create pull request
7.Revisão e merge:
Merge serve para juntar a sua Branch com a MAIN.
Para realizar o Merge é necessário a aprovação, para isso é recomendado marcar o Danilo, responsável por permitir o Merge com a MAIN, para que o processo seja mais rápido.
OBS: Após a realização do Merge, é recomendado excluir a sua Branch para manter a organização.
8.Fechamento da issue:
Após a realização do Merge, vá para a pagina de issues e arraste a tarefa para pronto
.
Assim finalizando a tarefa.