... | ... | @@ -14,108 +14,58 @@ Esta seção é dedicada a apresentar o processo de desenvolvimento do time, jun |
|
|
- [Plano de Comunicação](#plano-de-comunicação)
|
|
|
- [Plano de Riscos](#plano-de-riscos)
|
|
|
|
|
|
## Git Workflow
|
|
|
# Git Workflow
|
|
|
|
|
|
### Branches
|
|
|
|
|
|
#### Nomes
|
|
|
O padrão utilizado para nomenclatura da branches será em inglês e deve seguir o padrão feat/nome-da-feature,
|
|
|
onde os nomes podem ser retirados diretamente do [Trello](https://trello.com/b/kPW0AqTb/vou-imigrar-ages).
|
|
|
Caso seja necessário alguma correção, deverá ser modificado o prefixo para "fix", exemplo fix/nome-da-feature.
|
|
|
|
|
|
Como padrão para nomes de branches, foi decidido o seguinte:
|
|
|
|
|
|
Primeiramente vá para a branch develop e atualize para a versão atual:
|
|
|
```
|
|
|
<tipoDeItem>-<nomeDoItem>
|
|
|
git checkout develop
|
|
|
git pull
|
|
|
```
|
|
|
|
|
|
Exemplo de Componentes:
|
|
|
|
|
|
```
|
|
|
component-navBar
|
|
|
component-slider
|
|
|
```
|
|
|
|
|
|
Exemplo de Páginas:
|
|
|
|
|
|
```
|
|
|
page-recipes
|
|
|
page-creations
|
|
|
```
|
|
|
|
|
|
#### Criação
|
|
|
|
|
|
Para garantir que o processo de desenvolvimento esteja sempre atualizado, lembre-se de executar o seguinte comando na branch dev antes de criar uma branch nova:
|
|
|
|
|
|
Caso a branch da feature ainda não estiver criada utilize:
|
|
|
```
|
|
|
git pull origin dev
|
|
|
git checkout -b nome-da-branch
|
|
|
```
|
|
|
|
|
|
Depois da execução desse comando é necessário oficialmente criar a Branch, para isso, execute o seguinte comando:
|
|
|
|
|
|
### Commits
|
|
|
Após executar este comando você estará na nova branch, faça as alterações necessárias no código e commite as mudanças:
|
|
|
```
|
|
|
git checkout -b <nomeDaBranch>
|
|
|
git add .
|
|
|
git commit -m "comentario-do-commit"
|
|
|
```
|
|
|
O comentário deve descrever o que foi alterado no código e deverá ser em inglês. Não hesite em realizar vários commits, assim podemos o desenvolvimento fica melhor documentado.
|
|
|
|
|
|
Assim que criar a branch, é necessário fazer um `push`para garantir que a mesma estará remota:
|
|
|
|
|
|
Após, se for o primeiro commit dessa branch, para que ela troque de local para remote:
|
|
|
```
|
|
|
git push --set-upstream origin <nomeDaBranch>
|
|
|
git push --set-upstream origin nome-da-branch
|
|
|
```
|
|
|
|
|
|
Pronto! Agora você já pode começar a programar na sua Branch.
|
|
|
|
|
|
### Commits
|
|
|
|
|
|
Para que o código desenvolvido seja salvo em sua branch de maneira remota, é necessário realizar os comandos de `commit` e `push`
|
|
|
|
|
|
#### Salvando Localmente
|
|
|
|
|
|
Para garantir que apenas o código necessário para funcionamento da tarefa lembre-se de realizar o comando `add` apenas nos arquivos **essenciais** para a tarefa:
|
|
|
|
|
|
Caso contrário realize um:
|
|
|
```
|
|
|
git add <nomeDoArquivo>
|
|
|
git push
|
|
|
```
|
|
|
Lembre de sempre enviar seus commits para o remoto com o uso do `git push` após realizar seu trabalho, assim os outros desenvolvedores terão sempre as ultimas atualizações do código.
|
|
|
### Merge requests
|
|
|
|
|
|
Depois de adicionar todos os arquivos que deseja salvar, execute o commando de commit com uma mensagem curta que represente o que foi trabalhado nesses arquivos adicionados:
|
|
|
|
|
|
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 se certificar que não terá conflitos, siga os seguintes passos:
|
|
|
```
|
|
|
git commit -m 'descrição da tarefa em português'
|
|
|
git checkout develop
|
|
|
git pull
|
|
|
git checkout nome-da-branch
|
|
|
git merge develop
|
|
|
```
|
|
|
|
|
|
Não hesite em realizar vários commits, assim podemos ter docuemntado e salvo vários estados do desenvolvimento
|
|
|
|
|
|
#### Salvando Remotamente
|
|
|
|
|
|
Depois de finalizar o desenvolvimento, envie todos os commits da sua máquina para o servidor remoto. Para isso depois de realizar as etapas de salvamento local, salve remotamente com o comando `push`:
|
|
|
|
|
|
Resolva os conflitos caso ocorra, após resolvê-los, envie as alterações para o Gitlab:
|
|
|
```
|
|
|
git push
|
|
|
```
|
|
|
|
|
|
### 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:
|
|
|
|
|
|
1. Selecionar a branch de origem (sua branch de desenvolvimento);
|
|
|
2. Selecionar a branch de destino (branch dev);
|
|
|
3. Selecione `Compare branches and continue`
|
|
|
4. Em `Title`, escreva um título que descreva a funcionalidade adicionada ou bug corrigido;
|
|
|
5. Em `Description`, escreva uma descrição com uma breve justificativa nos arquivos que foram alterados;
|
|
|
6. Caso a tarefa seja visual (criação de componente/tela, correção de bug) adicione um gif exemplificando o uso (se considerar necessário);
|
|
|
7. Na seção `Assignee`, selecione `Assign 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);
|
|
|
8. Em `Milestone` selecione a Sprint em que a tarefa foi realizada;
|
|
|
9. Em `Labels`selecione qual é o tipo de tarefa que foi realizada;
|
|
|
10. Por último, revise se os arquivos que estão sendo enviados estão corretos e clique em `Submit Merge Request`.
|
|
|
|
|
|
#### Revisando o Merge Request
|
|
|
|
|
|
A revisão de merge request pode ser realizada por qualquer desenvolvedor, mas é preciso da aprovação de pelo menos um AGES III ou AGES IV para que a mesma seja incorporada na dev.
|
|
|
|
|
|
Na hora de revisar o Merge Request, entre na branch em sua máquina e teste a funcionalidade/bug/componente/tela de acordo com os critérios de aceitação apresentados no [Airtable](https://airtable.com/tblV0c8w2YX9PZAAC/viw4mJkZmd28WlplE?blocks=hide).
|
|
|
|
|
|
Caso haja pendências, relacionadas a documentação do código, padronização ou arquivos enviados, não exite em realizar um novo commit na branch com as mudanças necessárias antes de realizar a integração.
|
|
|
Abra o merge request da sua branch para a develop, no título coloque o nome da feature que foi desenvolvida,
|
|
|
e descreva brevemente o que foi realizado no campo de descrição.
|
|
|
|
|
|
## Matriz de Responsabilidade
|
|
|
|
... | ... | |