docs/policies/issues.md
# Política de criação de _Issue_.
* Documento cujo objetivo é de instruir os membros do projeto de como padronizar a criação de uma _issue_ e suas respectivas marcações.
## 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 do tutorial de como abrir uma issue| Rafael e Roberto|
---
## 1. <a nome="1">Nome da Issue</a>
Preencher o Título da _Issue_ adequadamente com um nome simples e descritivo.
Caso a issue seja uma história de usuário, deve-se criar a issue da seguinte forma:
- USXX - Nome da história de usuário. (Onde XX representa o número da história de usuário)
## 2. <a nome="1">Corpo da Issue</a>
### 2.1 <a nome="2.1">Descrição</a>
Descrever de maneira clara e objetiva o propósito da issue e se possui algum aspecto específico como dependências de outras issues.
### 2.2 <a nome="2.2">Tarefas</a>
As atividades a serem realizadas naquela issue devem ser citadas aqui até receberem um check.
Exemplo:
- `[ ] Tarefa 1`
- `[x] Tarefa 2`
### 2.3 <a nome="2.3">Critérios de aceitação</a>
Caso os critérios de aceitação já tenham sido definidos pela equipe, colocá-los aqui. Caso eles tenham sido atingidos, marcar com um check.
Exemplo:
- `[ ] Critério de aceitação 1`
- `[x] Critério de aceitação 2`
## 3. <a nome="3">Pipelines</a>
![](https://user-images.githubusercontent.com/74625814/109853334-8ebfa500-7c34-11eb-8e38-a95bad557957.png)
A Pipeline deve representar o estado do workflow que a issue está no momento.
Ex: (Nova Issue, Em progresso)
## 4. <a nome="4">Assignees</a>
![](https://user-images.githubusercontent.com/74625814/109866521-1fea4800-7c44-11eb-9da3-8ecd57596740.png)
A issue deve ser atribuída a pelo menos um colaborador do projeto.
## 5. <a nome="5">Labels</a>
![](https://user-images.githubusercontent.com/74625814/109854512-e27ebe00-7c35-11eb-82b5-7e17150f4216.png)
A issue deve ser marcada com uma ou mais tags que forem adequadas para servir como objeto de rastreamento do projeto.
## 6. <a nome="6">Milestone</a>
![](https://user-images.githubusercontent.com/74625814/109854186-80be5400-7c35-11eb-9b5a-302a588270f0.png)
A issue deve ser atribuída ao Milestone (sprint) correspondente previsto para sua execução.
## 7. <a nome="7">Estimate</a>
![](https://user-images.githubusercontent.com/74625814/109854286-a0557c80-7c35-11eb-8c79-49ddf88e2640.png)
Deve se adicionar à issue uma pontuação correspondente a sua expectativa de dificuldade.
## 8. <a nome="8">Epics</a>
![](https://user-images.githubusercontent.com/74625814/109854332-afd4c580-7c35-11eb-9a89-9b8555d87b40.png)
Somente utilizado em Histórias de Usuários, deve ser adicionado um épico na qual a issue está relacionada no projeto.
## 9. <a nome="9">Referências</a>
GABRIEL, Enzo; et al. POLÍTICA DE CRIAÇÃO DE ISSUE - Vamos Cuidar. Disponível em: <https://fga-eps-mds.github.io/2020.1-VC_Usuario/#/docs/policies/issues>. Acesso em: 03 mar 2021.