Politica de issues
Toda contribuição para o objeto deverá estar relacionada a uma issue para facilitar o acompanhamento das contribuições com o objetivo de mitigar o risco de trabalho duplicado, facilitar a organização das tarefas assim como distribuição das mesmas. Nesta pagina será definida a padronização da criação/classificação/atualização/acompanhamento das issues. As issues deverão ser simples, mas objetivas.
Antes de criar qualquer issue deve-se verificar se:
- Você conhece a politica de issues?
- Existe um problema, uma solução, modificação, reparo a ser realizado no projeto?
- Já existe uma issue relacionada?
Se todas as perguntas são satisfeitas dê continuidade a criação.
Descreva o problema sucintamente, seja objetivo na descrição da issue Um padrão a ser seguido no titulo da issue é: [VERBO] + [SUBSTANTIVO] Exemplo:
- Manter Aluno
- Corrigir bug do front end
- Criar uma nova Modelagem de Processos (Bizagi)
No corpo da issue deve-se especificar melhor como é possível resolver a issue ou quais são especificamente os problemas encontrados motivo pelo qual a issue foi criada. Boas praticas para o corpo da issue:
- Criar checklist de atividades
- Descrição detalhada do problema a ser resolvido
- Como reproduzir o bug/erro
As labels servem para classificar as issues de uma maneira simples, iterativa. Elas facilitam a identificação do tipo de issue. Cada label terá um prefixo indicador, que representa a resposta das seguintes perguntas em relação a issue:
- Nova feature (New feature)
- Divida técnica (Technical debt)
- Documentação (Documentation)
- Python/Django
- CSS/HTML
- UML
- Metodologia
- Fácil (Easy)
- Médio (Medium)
- Difícil (Hard)
- Baixo (Low priority)
- Alta (High priority)
Cores distintas também serão usadas nas labels para facilitar a identificação
A cada commit ou documento incrementado a uma issue, está issue deve ser notificada para facilitar a rastreabilidade do desenvolvimento. Para commits vide Politica de commits, para documentos na Wiki use o corpo de comentários da issue ou o check no checklist.
