Este guia descreve o fluxo de trabalho para contribuir com o projeto. O processo é simples e foi pensado para facilitar a organização e o acompanhamento das tarefas.
Certifique-se de que você tem acesso ao repositório e às tarefas no Jira. Caso não tenha, envie uma mensagem no WhatsApp para o responsável do projeto para configurar seu acesso.
Antes de começar a trabalhar, é necessário clonar o projeto do repositório remoto para sua máquina local. Você pode fazer isso de duas formas: usando o terminal ou uma ferramenta gráfica.
- Faça login no GitHub com o comando
gh auth
(se ainda não tiver feito):gh auth login
- Copie o link HTTPS ou SSH do repositório no GitHub.
- No terminal, use o comando:
Exemplo:
git clone URL-DO-REPOSITORIO
git clone https://github.com/usuario/projeto.git
- Baixe e instale o GitHub Desktop.
- Faça login na sua conta GitHub.
- No repositório, clique em Code e escolha a opção Open with GitHub Desktop.
- Siga as instruções para clonar o projeto.
Antes de começar o desenvolvimento, crie uma nova branch com base na branch main
. A nomenclatura deve seguir o seguinte padrão:
ID-DO-CARD-NO-JIRA/breve-descricao
Exemplo: Para a tarefa "Desenvolver cabeçalho" com o ID SC-7 no Jira, sua branch deve ser nomeada como:
SC-7/desenvolver-cabecalho
-
Certifique-se de estar na branch
main
:git checkout main
-
Atualize a branch
main
local com a versão mais recente do repositório remoto:git pull origin main
-
Crie e mude para a nova branch:
git checkout -b ID-DO-CARD-NO-JIRA/breve-descricao
Exemplo real:
git checkout -b SC-7/desenvolver-cabecalho
Log: Adicionado comando para criar uma nova branch.
Trabalhe na branch que você criou, implementando as alterações necessárias. Faça commits com mensagens claras e explicativas sobre o que foi feito.
-
Adicione os arquivos alterados ao commit:
git add .
-
Faça o commit com uma mensagem clara:
git commit -m "[ID-DO-CARD] Breve descrição do que foi feito"
Exemplo:
git commit -m "[SC-7] Desenvolvido cabeçalho inicial"
-
Envie suas alterações para o repositório remoto:
git push origin ID-DO-CARD-NO-JIRA/breve-descricao
Exemplo:
git push origin SC-7/desenvolver-cabecalho
Log: Adicionado comando para fazer commit e enviar alterações.
Quando terminar o desenvolvimento da sua tarefa:
- Acesse o repositório no GitHub ou GitLab.
- Localize a sua branch no menu de branches.
- Clique em New Pull Request (ou equivalente).
- Certifique-se de que a base da Pull Request é a branch
main
. - Inclua uma descrição clara do que foi implementado.
- Envie a Pull Request para análise.
Log: Pull Request criada.
Após criar a Pull Request, mova o card correspondente no Jira para a coluna Aguardando Aprovação.
- Clone o projeto:
git clone URL-DO-REPOSITORIO
ou use o GitHub Desktop. - Crie uma branch:
git checkout -b ID-DO-CARD-NO-JIRA/breve-descricao
. - Implemente e commite suas mudanças:
git add .
egit commit -m "[ID-DO-CARD] Breve descrição"
. - Envie para o repositório remoto:
git push origin ID-DO-CARD-NO-JIRA/breve-descricao
. - Crie a Pull Request.
- Atualize o status no Jira.
Em caso de dúvidas, entre em contato com o responsável pelo projeto. Estamos aqui para ajudar!
Log: Atualizado status no Jira.