Home | Escopo e Cronograma | Processo | Design/Mockups | Configuração | Arquitetura | Infra | Código | BD |
---|
Processo de Desenvolvimento
Para o gerenciamento do projeto e acompanhamento das tarefas, foi criado um board no ClickUp, onde temos todas as tarefas separadas e organizadas.
GitFlow
No projeto, seguimos o GitFlow conforme a imagem abaixo:
Diagrama do GitFlow
Branches
Toda branch terá todo seu texto em minúsculo com palavras separadas por -
.
Nome da Branch deverá seguir a seguinte estrutura: (prefixo)/(número da task)-(nome da task)
Exemplo: feat/01-componente-botao
Prefixos
- feat: trabalho em uma feature nova
- test: criação/edição dos testes de uma funcionalidade
- fix: correção de algum bug ou problema na aplicação
- refactor: refatoração de alguma parte do código
- docs: ajustes na documentação/README
- style: ajustes na formatação do código
- build: ajustes referentes a CI/CD
Commits
Apenas descrever o que foi feito no gerúndio.
Exemplo: Desenvolvendo o componente de botão
main
Branch principal do projeto, apenas código testado e validado pode ir para a main.
develop
Branch de integração dos códigos desenvolvidos durante uma sprint. Todo MR de funcionalidades e correções é aberto para a develop.
Estrutura de um Merge Request
Título
Prefixado com o número da tarefa, deve ser conciso e sucinto no que foi alterado
Descrição
Aqui é o espaço para detalhar as alterações feitas, decisões tomadas e até mesmo explicar até mesmo porque algumas coisas foram alteradas.
- Caso tenha trabalhado em uma tela, forneça screenshots das telas criadas/alteradas caso tenha alguma mudança visual. Caso seja um componente, adicione alguns exemplos de uso (tamanho, cores...).
- Se houver alguma alteração no contrato de um endpoint já criado, explique detalhadamente as mudanças realizadas e, se possível, inclua exemplos de requisição utilizando Postman/Scala.
Instalação do Git
Download
Faça o download e instale o Git a partir deste link, selecionando seu sistema operacional.
Ao final da instalação, abra o Git Bash (caso esteja usando Windows) ou um terminal, e digite git –version
. Ao retornar a versão do Git, significa que a instalação foi bem sucedida.
Nota: Usuários de Linux e Mac já possuem o Git nativamente. Para verificar, abra um terminal e digite
git –version
. Caso retorne a versão do Git, significa que o mesmo está devidamente instalado em sua máquina.