... | @@ -80,23 +80,27 @@ Branch default para desenvolvimento. Esta deve ser a branch de partida de todas |
... | @@ -80,23 +80,27 @@ Branch default para desenvolvimento. Esta deve ser a branch de partida de todas |
|
|
|
|
|
Quando é feito merge de um MR para essa branch, a Pipeline de CI é disparada para checagem e em caso de sucesso o deploy é feito automaticamente para o ambiente de DEV.
|
|
Quando é feito merge de um MR para essa branch, a Pipeline de CI é disparada para checagem e em caso de sucesso o deploy é feito automaticamente para o ambiente de DEV.
|
|
|
|
|
|
#### Branches não protegidas (feature/fix/chore):
|
|
#### Branches não protegidas (feature/fix/chore/Hotfix):
|
|
|
|
|
|
**Feature:** branches para implementação de funcionalidades novas. O padrão de nomenclatura é _feature/<contexto>_ onde _<contexto>_ representa uma breve descrição do que está sendo implementado nesta branch. Exemplo: _feature/tela-cadastro_.
|
|
**Feature:** branches para implementação de funcionalidades novas. O padrão de nomenclatura é _feature/_ onde representa uma breve descrição do que está sendo implementado nesta branch. Exemplo: _feature/tela-cadastro_.
|
|
|
|
|
|
**Fix:** branches para correção de bugs. O padrão de nomenclatura é _fix/<contexto>_ onde _<contexto>_ representa uma breve descrição do que está sendo corrigido nessa branch. Exemplo: _fix/cor-errada-no-login_.
|
|
**Fix:** branches para correção de bugs. O padrão de nomenclatura é _fix/_ onde representa uma breve descrição do que está sendo corrigido nessa branch. Exemplo: _fix/cor-errada-no-login_.
|
|
|
|
|
|
**Chore:** branches para configuração. O padrão de nomenclatura é _chore/<contexto>_ onde _<contexto>_ representa uma breve descrição do que está sendo configurado nessa branch. Exemplo: chore\*/pipeline-ci\*.
|
|
**Chore:** branches para configuração. O padrão de nomenclatura é _chore/_ onde representa uma breve descrição do que está sendo configurado nessa branch. Exemplo: chore\*/pipeline-ci\*.
|
|
|
|
|
|
MRs dessas branches devem sempre ser abertos _para_ **develop**.
|
|
MRs dessas branches devem sempre ser abertos _para_ **develop**.
|
|
|
|
|
|
|
|
**Hotfix**: é um padrão específico para "furar" o fluxo de desenvolvimento e aplicar uma correção diretamente em um ambiente mais alto (no caso do projeto, produção). Uma branch hotfix segue o padrão _hotfix/_ onde representa uma breve descrição do que está sendo corrigido nessa branch.
|
|
|
|
|
|
|
|
Devem ser abertos 2 MRs: um para **main** e um para **develop**.
|
|
|
|
|
|
**Como posso criar uma branch?**
|
|
**Como posso criar uma branch?**
|
|
|
|
|
|
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:
|
|
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:
|
|
|
|
|
|
<div>
|
|
<div>
|
|
|
|
|
|
```
|
|
```plaintext
|
|
git pull origin dev
|
|
git pull origin dev
|
|
```
|
|
```
|
|
|
|
|
... | @@ -104,26 +108,20 @@ git pull origin dev |
... | @@ -104,26 +108,20 @@ git pull origin dev |
|
|
|
|
|
<div>
|
|
<div>
|
|
|
|
|
|
```
|
|
```plaintext
|
|
git checkout -b <nomeDaBranch>
|
|
git checkout -b <nomeDaBranch>
|
|
```
|
|
```
|
|
|
|
|
|
</div>Assim que criar a branch, é necessário fazer um `push`para garantir que a mesma estará remota:
|
|
</div>Assim que criar a branch, é necessário fazer um \`push\`para garantir que a mesma estará remota:
|
|
|
|
|
|
<div>
|
|
<div>
|
|
|
|
|
|
```
|
|
```plaintext
|
|
git push --set-upstream origin <nomeDaBranch>
|
|
git push --set-upstream origin <nomeDaBranch>
|
|
```
|
|
```
|
|
|
|
|
|
</div>Pronto! Agora você já pode começar a programar na sua Branch.
|
|
</div>Pronto! Agora você já pode começar a programar na sua Branch.
|
|
|
|
|
|
### hotfix
|
|
|
|
|
|
|
|
Hotfix é um padrão específico para "furar" o fluxo de desenvolvimento e aplicar uma correção diretamente em um ambiente mais alto (no caso do projeto, produção). Uma branch hotfix segue o padrão _hotfix/<contexto>_ onde _<contexto>_ representa uma breve descrição do que está sendo corrigido nessa branch.
|
|
|
|
|
|
|
|
Devem ser abertos 2 MRs: um para **main** e um para **develop**.
|
|
|
|
|
|
|
|
### Commits
|
|
### Commits
|
|
|
|
|
|
#### Salvando Localmente
|
|
#### Salvando Localmente
|
... | @@ -132,7 +130,7 @@ Para garantir que apenas o código necessário para funcionamento da tarefa lemb |
... | @@ -132,7 +130,7 @@ Para garantir que apenas o código necessário para funcionamento da tarefa lemb |
|
|
|
|
|
<div>
|
|
<div>
|
|
|
|
|
|
```
|
|
```plaintext
|
|
git add <nomeDoArquivo>
|
|
git add <nomeDoArquivo>
|
|
```
|
|
```
|
|
|
|
|
... | @@ -140,7 +138,7 @@ git add <nomeDoArquivo> |
... | @@ -140,7 +138,7 @@ git add <nomeDoArquivo> |
|
|
|
|
|
<div>
|
|
<div>
|
|
|
|
|
|
```
|
|
```plaintext
|
|
git commit -m 'descrição da tarefa em português'
|
|
git commit -m 'descrição da tarefa em português'
|
|
```
|
|
```
|
|
|
|
|
... | @@ -156,13 +154,11 @@ Depois de finalizar o desenvolvimento, envie todos os commits da sua máquina pa |
... | @@ -156,13 +154,11 @@ Depois de finalizar o desenvolvimento, envie todos os commits da sua máquina pa |
|
|
|
|
|
<div>
|
|
<div>
|
|
|
|
|
|
```
|
|
```plaintext
|
|
git push
|
|
git push
|
|
```
|
|
```
|
|
|
|
|
|
</div>
|
|
</div>### Merge Request
|
|
|
|
|
|
### Merge Request
|
|
|
|
|
|
|
|
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:
|
|
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:
|
|
|
|
|
... | @@ -170,37 +166,37 @@ Depois de uma task ter sido desenvolvida e estiver pronta de acordo com os crit |
... | @@ -170,37 +166,37 @@ Depois de uma task ter sido desenvolvida e estiver pronta de acordo com os crit |
|
|
|
|
|
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:
|
|
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);
|
|
1. [ ] Selecionar a branch de origem (sua branch de desenvolvimento);
|
|
2. Selecionar a branch de destino (branch dev);
|
|
* Selecionar a branch de destino (branch dev);
|
|
3. Selecione `Compare branches and continue`
|
|
* Selecione `Compare branches and continue`
|
|
4. Em `Title`, escreva um título que descreva a funcionalidade adicionada ou bug corrigido;
|
|
* Em `Title`, escreva um título que descreva a funcionalidade adicionada ou bug corrigido;
|
|
5. Em `Description`, utilize o padrão abaixo:
|
|
* Em `Description`, utilize o padrão abaixo:
|
|
|
|
|
|
```
|
|
```plaintext
|
|
### Issue number:
|
|
### Issue number:
|
|
|
|
|
|
Adicione aqui uma referência ao número do issue relacionado a esse MR (exemplo: [#11](https://www.linkDaIsue.com))
|
|
Adicione aqui uma referência ao número do issue relacionado a esse MR (exemplo: [#11](https://www.linkDaIsue.com))
|
|
|
|
|
|
### Descrição:
|
|
### Descrição:
|
|
|
|
|
|
Uma lista das mudanças relacionadas a esse MR
|
|
Uma lista das mudanças relacionadas a esse MR
|
|
|
|
|
|
- Mudanca 1
|
|
- Mudanca 1
|
|
- Mudanca 2
|
|
- Mudanca 2
|
|
|
|
|
|
### Checklist:
|
|
### Checklist:
|
|
|
|
|
|
* [ ] Não deixou string literais no código
|
|
* [ ] Não deixou string literais no código
|
|
* [ ] Utilizou as variáveis padronizadas do design system (cor, títulos/fontes, imagens e etc)
|
|
* [ ] Utilizou as variáveis padronizadas do design system (cor, títulos/fontes, imagens e etc)
|
|
* [ ] Não deixou nenhum código comentado
|
|
* [ ] Não deixou nenhum código comentado
|
|
|
|
|
|
### Foto da pipeline com status verde
|
|
### Foto da pipeline com status verde
|
|
```
|
|
```
|
|
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);
|
|
* 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);
|
|
* 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;
|
|
* Em `Milestone` selecione a Sprint em que a tarefa foi realizada;
|
|
9. Em `Labels`selecione qual é o tipo de tarefa que foi realizada;
|
|
* 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`.
|
|
* Por último, revise se os arquivos que estão sendo enviados estão corretos e clique em `Submit Merge Request`.
|
|
|
|
|
|
#### Revisando o Merge Request
|
|
#### Revisando o Merge Request
|
|
|
|
|
... | | ... | |