Politica de Criação de Pull Requests

Histórico de Versões

Data	Versão	Descrição	Autor
03/03	0.1	Abertura do documento com template inicial	Rafael e Roberto
03/03	0.2	Adição dos tópicos 2 e 3	Rafael e Roberto

1. Introdução

Esse documento tem por objetivo padronizar a confecção de Pull Requests(PR) no Anunbis. É sempre importante que os PR's sejam detalhados e contenham a explicação suficiente para sua correta aprovação, e, por isso, essa politica é muito necessária.

2. Nome do Pull Request

Os nomes dos PR devem conter um resumo geral do conteúdo do pull. Ao ler o título, a ideia do foi feito deve ser clara.

Os nomes dos PR's devem seguir o seguinte padrão:

#NN Titulo do PR

Onde:

NN é o número da issue ao qual o PR se refere.

Exemplo:

#75 Criação do Login

3. Corpo do Pull Request

O corpo do PR deve ser bem detalhado, de forma que tudo que foi executado seja bem entendido por quem está lendo. Deve possuir os seguintes itens:

3.1 Descrição

Destinada a um resumo sucinto do que foi executado, demonstrando o que foi trabalhado

3.2 Resolve Issues

Aqui deve ser explicitado qual(ais) issue(s) aquele PR resolve.

O seguinte padrão deve ser seguido:

#NN Nome da Issue

Onde:

NN é o número da issue.

Exemplo:

#55 Criar Backlog

3.3 Como isso foi testado?

Espaço reservado para explicar como as modificaçẽos feitas no PR foram executadas.

3.4 Capturas de Telas (Se apropriado)?

Aqui estarão as imagens demonstrando o que foi mudado, na visão do usuário. É útil para mudanças visuais do projeto, como no frontend.

3.5 Tarefas Gerais Realizadas

Campo onde ocorre uma descrição um pouco mais detalhada das tarefas executadas no PR.

4. Referências

GABRIEL, Enzo; et al. Política de Branches - Vamos Cuidar. Disponível em: https://fga-eps-mds.github.io/2020.1-VC_Usuario/#/docs/policies/pull_request. Acesso em: 03 mar 2021.