Politica de Pull Request
Histórico de Versão
| Data | Data Prevista de Revisão | Versão | Descrição | Autor | Revisor |
|---|---|---|---|---|---|
| 11/11/2022 | 11/11/2022 | 1.0 | Criação do Documento de Políticas | joão Lucas | Ana Luiza |
Criação de Pull Request
Considere uma situação hipotética onde estamos querendo criar um PR de uma branch chamada Sprints para a master.
Nota
- A criação do PR deve ser feita logo após o início do trabalho em uma issue. Para isso trabalhamos com a flag de status WIP.
Para a criação de um pull request direcionado a branch master, deve-se seguir os seguintes passos:
Passo a passo
Adicione a flag de status
- Titule o PR com a tag WIP (ou seja work in progress)
Adicione uma descrição
- Utilize o template de issue destinada ao pull request.
- Lembrando que o pull request tem a branch base a main e a compare a branch que se deseja juntar.
- Lembrando: assim que for realmente finalizado as alterações referentes ao pull request, deve-se retirar a tag WIP.
Exemplo de como abrir um PR na figura 1 :
Figura 1 - Abrir um PR
Adicione os reviewers
- Assinale os reviewers, ou seja, aqueles responsáveis pela análise do pull request. Por exemplo, caso sua feature esteja relacionada a arquitetura do projeto, assinale o EPS que desempenha esse papel.
Exemplo de como adcionar revisores na figura 2 :
Figura 2 - Adicionar um Revisor
Adicione os assignees
- Assinale os colaboradores do pull request
Exemplo de como adcionar colaboradores na figura 3 :
Figura 3 - Adicionar Colaboradores
Adicione as devidas labels
- Marque as labels relacionadas ao pull request. Geralmente será as mesmas assinaladas na issue referente.
Exemplo de como selecionar marcadores na figura 4 :
Figura 4 - Adicionar Marcadores
Adicione a devida milestone
- Marque a Milestone, ou seja, a sprint ou release atual.
Exemplo de como selecionar a milestone na figura 5 :
Figura 5 - Adicionar Milestone
Explicite a issue relacionada ao PR
- Conecte a issue trabalhada neste pull request por meio de closing keywords.
| Issue a ser linkada | Sintaxe | Examplo |
|---|---|---|
| Issue dentro deste repositório | KEYWORD #ISSUE-NUMBER | Closes #10 |
Conflitos
- Se um pull request causar algum tipo de conflito, deve ser resolvido primeiro pela equipe que desenvolveu o que está causando conflito, prezando pela integridade e organização do histórico de commits, e então deve ser refeito o pedido para avaliação do merge.
Política de Aprovação do Código
- Para a aprovação do código, este deve ser aprovado por ao menos um dos integrantes do grupo