Skip to content

Template Descrição de Issue

Juan Funez edited this page Jan 21, 2016 · 2 revisions

Visando ter clareza na descrição de uma tarefa, é desejável mantermos o mesmo padrão no momento de descrever um issue. Para isso podemos utilizar o seguinte template:

#### Problema:
Descrição breve e clara do problema. Por exemplo: A versão da dependência: Flask-Admin esta desatualizada.

#### Objetivo:
Lista de pontos a ser resolvidos. Por exemplo:
- Visando não ficarmos com dependências antigas (ajustando o arquivo: ``requirements.txt``) devemos atualizar ...
- Acrescentar uma regra no Makefile ...

#### Observações (opcional):
Lista de dicas, anotações, ou qualquer informação a considerar: Por exemplo: 
- Verificar que os templates personalizados continuem funcionado depois da atualização.

#### Dependências/Impedimentos:
As vezes a tarefa requer que outra tarefa seja finalizada antes. 
Para isso temos esta seção com as anotações que explicam este tipo de situações.
Por exemplo: 
- Para realizar esta tarefa, o issue #12 deve ser incorporado/resolvido previamente.