docs/policies/pullRequests.md
# 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. <a name="1">Introdução</a>
<p align = "justify">    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. </p>
## 2. <a name="2">Nome do Pull Request</a>
<p align = "justify">    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. </p>
* Os nomes dos PR's devem seguir o seguinte padrão:
```
#NN Titulo do PR
```
<p align = "justify">  Onde:</p>
* <b>NN</b> é o número da issue ao qual o PR se refere.
<p align = "justify">  Exemplo:</p>
```
#75 Criação do Login
```
## 3. <a name="3">Corpo do Pull Request</a>
<p align = "justify">    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: </p>
### 3.1 <a name="3.1">Descrição</a>
<p align = "justify">    Destinada a um resumo sucinto do que foi executado, demonstrando o que foi trabalhado</p>
### 3.2 <a name="3.2">Resolve Issues</a>
<p align = "justify">    Aqui deve ser explicitado qual(ais) issue(s) aquele PR resolve.</p>
* O seguinte padrão deve ser seguido:
```
#NN Nome da Issue
```
<p align = "justify">  Onde:</p>
* <b>NN</b> é o número da issue.
<p align = "justify">  Exemplo:</p>
```
#55 Criar Backlog
```
### 3.3 <a name="3.3">Como isso foi testado?</a>
<p align = "justify">    Espaço reservado para explicar como as modificaçẽos feitas no PR foram executadas.</p>
### 3.4 <a name="3.4">Capturas de Telas (Se apropriado)?</a>
<p align = "justify">    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.</p>
### 3.5 <a name="3.5">Tarefas Gerais Realizadas</a>
<p align = "justify">    Campo onde ocorre uma descrição um pouco mais detalhada das tarefas executadas no PR.</p>
## 4. <a nome="4">Referências</a>
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.