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. Nome da Issue
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. Corpo da Issue
2.1 Descrição
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 Tarefas
As atividades a serem realizadas naquela issue devem ser citadas aqui até receberem um check.
Exemplo:
[ ] Tarefa 1
[x] Tarefa 2
2.3 Critérios de aceitação
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. Pipelines
A Pipeline deve representar o estado do workflow que a issue está no momento.
Ex: (Nova Issue, Em progresso)
4. Assignees
A issue deve ser atribuída a pelo menos um colaborador do projeto.
5. Labels
A issue deve ser marcada com uma ou mais tags que forem adequadas para servir como objeto de rastreamento do projeto.
6. Milestone
A issue deve ser atribuída ao Milestone (sprint) correspondente previsto para sua execução.
7. Estimate
Deve se adicionar à issue uma pontuação correspondente a sua expectativa de dificuldade.
8. Epics
Somente utilizado em Histórias de Usuários, deve ser adicionado um épico na qual a issue está relacionada no projeto.
9. Referências
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.