-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#51 Adicionando conteudo ao politica de pullRequest
Co-authored-by: Rafael <rafael.cleydson@gmail.com>
- Loading branch information
1 parent
c752fd7
commit 99a8d96
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Politica de Criação de Pull Requests | ||
|
|
||
| --- | ||
|
|
||
| ## 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: | ||
| <p align = "justify">      <i>#NN Titulo do PR</i></p> | ||
|
|
||
| <p align = "justify">  Onde:</p> | ||
|
|
||
| * <b>NN</b> é o número da issue ao qual o PR se refere. | ||
|
|
||
| <p align = "justify">  Exemplo:</p> | ||
|
|
||
| <p align = "justify">      <i>##75 Criação do Login</i></p> | ||
|
|
||
|
|
||
| ## 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 sucindo 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: | ||
|
|
||
| <p align = "justify">      <i>#NN Nome da Issue</i></p> | ||
|
|
||
| <p align = "justify">  Onde:</p> | ||
|
|
||
| * <b>NN</b> é o número da issue. | ||
|
|
||
| <p align = "justify">  Exemplo:</p> | ||
|
|
||
| <p align = "justify">      <i>#55 Criar Backlog</i></p> | ||
|
|
||
| ### 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> | ||
|
|
||
| ## 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. |