|
|
|
|[Home](home)|[Escopo e Cronograma](escopo)|[Mockups](mockups)|[Configuração](configuracao)|[Arquitetura](arquitetura)|[BD](banco_dados)|[Instalação](instalacao)|[Gerência](gerencia)|[Qualidade](qualidade)|[**Processo**](processo)|[Versionamento](versionamento)|[Horários](horarios)
|
|
|
|
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|[Home](home)|[Escopo e Cronograma](escopo)|[Mockups](mockups)|[Configuração](configuracao)|[Arquitetura](arquitetura)|[BD](banco_dados)|[Instalação](instalacao)|[Gerência](gerencia)|[**Processo**](processo)|[Horários](horarios)
|
|
|
|
|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
# Processo de Desenvolvimento
|
|
|
|
|
| ... | ... | @@ -21,103 +21,49 @@ Esta seção é dedicada a apresentar o processo de desenvolvimento do time, jun |
|
|
|
|
|
|
|
## Git Workflow
|
|
|
|
|
|
|
|
### Branches
|
|
|
|
### Utilizaremos o **inglês** como padrão de nomenclaturas de versionamento e implementação (variáveis e métodos)
|
|
|
|
|
|
|
|
#### Nomes
|
|
|
|
Primeiramente vá para a branch dev e atualize para a versão atual:
|
|
|
|
|
|
|
|
git checkout dev
|
|
|
|
git pull
|
|
|
|
|
|
|
|
Como padrão para nomes de branches, foi decidido o seguinte:
|
|
|
|
Após, inicie a implementação na branch `dev`
|
|
|
|
|
|
|
|
```
|
|
|
|
<tipoDeItem>-<nomeDoItem>
|
|
|
|
```
|
|
|
|
Após terminar de implementar e testar as alterações localmente, atualize novamente a branch e crie uma nova branch com o comando:
|
|
|
|
|
|
|
|
Exemplo de Componentes:
|
|
|
|
git checkout -b nome-da-branch
|
|
|
|
|
|
|
|
```
|
|
|
|
component-navBar
|
|
|
|
component-slider
|
|
|
|
```
|
|
|
|
Ao executar esse comando você estará na nova branch com as suas implementações.
|
|
|
|
|
|
|
|
Exemplo de Páginas:
|
|
|
|
Após, é possível realizar o commit da tarefa:
|
|
|
|
|
|
|
|
```
|
|
|
|
page-recipes
|
|
|
|
page-creations
|
|
|
|
```
|
|
|
|
git add .
|
|
|
|
git commit -m "comentario-do-commit"
|
|
|
|
|
|
|
|
#### Criação
|
|
|
|
Após, se for o primeiro commit dessa branch, para que ela troque de `local` para `remote`:
|
|
|
|
|
|
|
|
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:
|
|
|
|
git push --set-upstream origin nome da sua branch
|
|
|
|
|
|
|
|
```
|
|
|
|
git pull origin dev
|
|
|
|
```
|
|
|
|
Após, abrir o GitLab do repositório e abrir um Merge Request para a `dev`:
|
|
|
|
|
|
|
|
Depois da execução desse comando é necessário oficialmente criar a Branch, para isso, execute o seguinte comando:
|
|
|
|
- Inserir um título para o MR
|
|
|
|
- Breve descrição do que foi implementado
|
|
|
|
- Selecionar a opção "Assign to me"
|
|
|
|
- Marcar a opção de deletar a branch após o Merge
|
|
|
|
|
|
|
|
```
|
|
|
|
git checkout -b <nomeDaBranch>
|
|
|
|
```
|
|
|
|
Abaixo segue o padrão de nomenclatura a ser usadas no projeto
|
|
|
|
|
|
|
|
Assim que criar a branch, é necessário fazer um `push`para garantir que a mesma estará remota:
|
|
|
|
## Nomenclatura de *Branches*
|
|
|
|
|
|
|
|
```
|
|
|
|
git push --set-upstream origin <nomeDaBranch>
|
|
|
|
```
|
|
|
|
Para padronização, as *branches* deverão ser criadas a partir do seguinte modelo:
|
|
|
|
|
|
|
|
Pronto! Agora você já pode começar a programar na sua Branch.
|
|
|
|
Usaremos duas palavras para identificar implementação nova `feat` ou correção de algum bug `fix`. Segue exemplo abaixo:
|
|
|
|
|
|
|
|
### Commits
|
|
|
|
feat/email-validation
|
|
|
|
|
|
|
|
Para que o código desenvolvido seja salvo em sua branch de maneira remota, é necessário realizar os comandos de `commit` e `push`
|
|
|
|
## Nomenclatura de *Commits*
|
|
|
|
|
|
|
|
#### Salvando Localmente
|
|
|
|
Os comentários de `commit` devem ser o mais sucinto e explicativo possível, exemplo:
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
```
|
|
|
|
git add <nomeDoArquivo>
|
|
|
|
```
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
```
|
|
|
|
git commit -m 'descrição da tarefa em português'
|
|
|
|
```
|
|
|
|
|
|
|
|
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`:
|
|
|
|
|
|
|
|
```
|
|
|
|
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. |
|
|
\ No newline at end of file |
|
|
|
add validation login email |
|
|
\ No newline at end of file |
