Home | Escopo e Cronograma | Processo | Design/Mockups | Configuração | Arquitetura | Código | BD | Qualidade | Utilização | Instruções AWS |
---|
Git
Menu
GitFlow
As atualizações da Developer serão feitos através de Pull Requests
Opções de Ferramentas
GitKraken
- Download do GitKraken.
essa ferramenta facilita o uso do git através de uma interface intuitiva
GitBash (Windows)
- Download do GitBash.
Comandos básicos
- clonar um repositório:
git clone ADICIONAR URL
- verificar o status do repositório:
git status
- CRIAR uma nova branch:
git checkout -b <branch desejada>
- ALTERNAR para uma branch:
git checkout <branch desejada>
- add arquivos alterados e dar um commit na branch:
git commit -a -m 'adicionei um novo rodapé [issue 53]'
- primeira vez a enviar os dados para o repositório.
git push origin <branch desejada>
- reenviar os dados para o repositório.
git push
- baixar os dados do repositório.
git pull
- fazer um merge em duas branch's.
git merge <nome da branch>
Padrão para criação de branches
As branches criadas para desenvolvimento das funcionalidades pelas squads devem seguir o padrão e de acordo com seu objetivo:
Tags para os tipos de alterações:
- feat - Nova funcionalidade
- fix - Correção de defeito
- docs - Alteração de documentação
- style - Alterações visuais que não possuem alteração em codigo fonte
- refactor - Reescrever um código para corrigir um bug ou adicionar uma nova funcionalidade
- perf - Melhorar performance do sistema
feat/NUM_TASK
Exemplo: feat/44
Padrão para as mensagens de commit
Os commits deverão ter um padrão em suas mensagens para facilitar o entendimento da equipe no que foi desenvolvido:
"Descrição breve do commit - Autores (caso realizado em equipe)"
Exemplo: "Compare button done - Duda, Martin e Pedro"
OBS: Caso as atividades do commit tenham sido realizadas individualmente não é necessário informar os autores, porque a única pessoa envolvida será quem está subindo o commit.
Merge Requests
Depois de uma task ter sido desenvolvida e estiver pronta de acordo com os critérios de aceitação, é necessário que a mesma seja enviada para a branch de desenvolvimento. Para isso é necessário abrir um Merge Request pela platafora GitLab:
Criando o Merge Request
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:
- Selecionar a branch de origem (sua branch de desenvolvimento);
- Selecionar a branch de destino (branch develop);
- Selecione
Compare branches and continue
- Em
Title
, escreva um título que descreva a funcionalidade adicionada ou bug corrigido; - Em
Description
, escreva uma descrição com uma breve justificativa nos arquivos que foram alterados; - Na seção
Assignee
, selecioneAssign 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); - Em
Milestone
selecione a Sprint em que a tarefa foi realizada; - Em
Labels
selecione qual é o tipo de tarefa que foi realiada; - Por último, revise se os arquivos que estão sendo enviados estão corretos e clique em
Submit Merge Request
.
Padrão para abertura de Merge Request
Os merge requests também devem seguir um padrão de criação:
O Title deve ser escrito UserStory - Título do Card no Trello
e na Description deve ser informado o link para o card, além de uma descrição da tarefa e se possível uma imagem/gif para visualização do que foi desenvolvido.
Exemplo:
Title: US04 - Criar componente de botão para navegar para a tela de comparação
Description: https://trello.com/c/d67o9cLk/26-us09-criar-menu
Critério de aceite de Merge Requests (MR)
- Branch testada
- Branch atualizada com a DEV
- Arquitetura Respeitada
- Código Limpo
- Boas práticas atendidas
Tutoriais
Código
Descrição
Aqui serão apresentadas as convenções do código desenvolvido. padrões, documentação e conceitos básicos serão alguns dos assuntos abordados.
Sumário
Ferramentas de Padronização
TBD
Nomenclatura de Arquivos
TBD
Documentação
TBD
Código
TBD