/SAP007-git-branching

Primary LanguageHTML

Git Branching

Este repositório tem como objetivo exercitar o uso de branches (ramos) no git.

Fluxo de trabalho

Segue o link para um vídeo explicativo do GitHub:

What is GitHub?

1. Acesso ao repositório como colaborador(a)

Um dos mentores enviará um convite de colaboração para o repositório. Você receberá esse convite pelo seu e-mail cadastrado no GitHub.

2. Clone

Clone o repositório:

  • opção SSH (caso você tenha configurado a chave SSH anteriormente):
git clone git@github.com:USERNAME/SAP007-git-branching.git
  • ou, opção HTTPS:
git clone https://github.com/USERNAME/SAP007-git-branching.git

Ⓘ onde USERNAME é o nome de usuário da conta que enviou o convite de colaboração.

Navegue até o diretório do repositório:

cd SAP007-git-branching

3. Branch

Crie uma branch nova com um nome adequado (dicas de nomenclatura):

git checkout -b feat/add-fulana-image

4. Install

Instale as dependências do projeto:

npm install

Rode o projeto:

npm start

5. Hacking

Altere a parte do código onde você quer que a funcionalidade seja implementada.

6. Commit

Realize o fluxo de commit.

Adicione o(s) arquivo(s) alterados da sua branch para a área de preparação (staging area):

git add src/index.html

Adicione a mensagem de commit (dicas de mensagem):

git commit -m "feat: adicionada a imagem da estudante fulana"

7. Push

Os colaboradores estão com permissão de dar push de sua branch local feat/add-fulana-image para o endereço remoto origin.

git push origin feat/add-fulana-image

8. Pull request (PR)

No github, você pode solicitar um pull request para o repositório remoto. Partindo da branch feat/add-fulana-image que você deseja implementar a funcionalidade para a branch main.

Adicione reviewers ao pull request para que possam revisar e aprovar sua solicitação de PR.

9. Merge

Após aprovado o PR, você deve fazer o merge da branch feat/add-fulana-image para branch main.

Deletar a branch feat/add-fulana-image do repositório remoto, pois ela já cumpriu o seu objetivo.

10. Pull

Em sua máquina, volte para a branch main:

git checkout main

Atualize o repositório local após o merge no GitHub em seu terminal:

git pull origin main

Delete a branch feat/add-fulana-image localmente:

git branch -D feat/add-fulana-image

11. Start

Verifique se o projeto está funcionando corretamente:

npm start

12. Deploy

Caso tudo esteja funcionando corretamente, você pode fazer o deploy do projeto:

npm run deploy

Dicas

Nomenclatura de branch e mensagens de commit

A padronização de mensagens de commit e nomes de branch facilitam o entendimento entre desenvolvedores.

Uma forma seria o formato do Commit Amigão:

  • feat (nova funcionalidade para o usuário)
  • style (formatação geral no código, como lint. Não confundir com CSS)
  • refactor (refatoração de código de produção)
  • test (adicionar/refatorar testes)
  • fix (correção de bug para o usuário)
  • docs (mudanças na documentação)
  • chore (atualização de tarefas ou código que não está relacionado a código em produção)

Conversa entre dois desenvolvedores sobre mensagem de commit

Fonte: Vida de Programador 🇧🇷

Referências