Proposta de templates para issues

bug-report-template.md

Descrição do problema

Descreva de forma clara e objetiva o problema relatado.

Passos para reproduzir o problema

1. Acesse a página ...
2. Clique no link ...
3. Role a página até ...
4. Observe o erro apresentado

Comportamento esperado

Descreva com clareza qual seria o comportamento esperado (correto) ao reproduzir os passos acima.

Screenshots ou vídeos

Para dar mais detalhes e contexto sobre o erro, considere anexar fotos ou vídeos do problema.

Anexos

Está seção é opcional, utilize para referenciar arquivos que servem de insumo para reproduzir o erro, ex:

• XML utilizado
• HTML produzido
• PDF criado

Ambiente utilizado

Quando aplicável, forneça detalhes sobre o ambiente utilizado, ex:

• Navegador Mozilla Firefox versão 30
• Windows XP
• PC programs versão 1.0
• Aparelho celular iPhone 7, iOS 7

feature-request-template.md

User Stories [1], Acceptance Criteria [2]

• Pronto é quando o requisito solicitado pode ser executado ou utilizado.
• O usuário ou o papel de usuário é de quem está solicitando a funcionalidade.
• Sub tarefas devem ser quebradas em issues.

Layout

Descrição do requisito

Eu como [tipo de cargo/ usuário / papel em sistema], gostaria que [descrição breve da funcionalidade], então [consequência ou o porque da requisição da atividade].

Critérios de aceitação

Lista de critérios a serem observados pela equipe de engenharia durante a elaboração e construção da tarefa. Seja claro(a), descreva os pontos que são importantes para você:

• Ex 1: Fale sobre qual deve ser o comportamento da funcionalidade;
• Ex 2: Fale sobre quais validações um formulário deve conter;
• Ex 3: Fale sobre os tipos de impressão uma página deve suportar;
• Ex 4: Fale sobre os tipos de usuários podem realizar a ação requisitada;
• Critério 5;
• Critério 6

Anexos

Este tópico é opcional mas pode ser utilizado para incluir objetos a serem analisados ou demonstrações que podem ser utilizados de exemplo.

Referências

Este tópico é opcional mas pode ser utilizado para enumerar items de referências como links ou bibliografia.

Exemplos

1) Descrição do requisito

Como Usuário Administrador do OPAC, gostaria que o botão de publicação de periódicos possuisse DESTAQUE, assim poderia ter um indicativo visual de cuidado antes de clicar.

Critérios de aceitação

Para que esta tarefa seja considerada concluída deve conter os seguintes pontos:

• O botão de publicação deve possuir um tom vermelho que se destaque dos outros elementos de tela;
• O botão deve conter o modo daltônico para que os membros daltônicos do time de publicação possam identifica-lo com facilidade;
• O botão deve ter conter um indicativo de "descrição de ação" ao posicionar o mouse e aguardar alguns segundos.

Anexos

N/A

Referências

N/A

---

2) Descrição do requisito

Como Usuário visitante do OPAC, gostaria que a página de artigos fosse adaptativa para celulares, assim poderia utilizar meu dispositivo móvel para navegar com mais facilidade.

Critérios de aceitação

Os seguintes pontos devem ser contemplados:

• Os botões de navegação nesta tela devem ser de fácil acesso e possuir fácil toque;
• Os textos nesta tela devem possuir tamanho adequado para leitura seguindo os padrões da W3C;
• Deve-se agrupar em blocos as seções de página para facilitar a navegabilidade;

Anexos

N/A

Referências

N/A

---

3) Descrição do requisito

Como administrador do processo de qualidade, gostaria de ter um pré visualizador de HTML, assim poderia validar a marcação dos XMLs antes de envia-lo para publicação.

Critérios de aceitação

Os seguintes pontos devem ser contemplados:

• O visualizador de HTML deve ser auto contido e não depender de internet;
• O visualizador de HTML deve funcionar a partir do SPS 1.8;
• O visualizador de HTML deve exibir o conteúdo da mesma forma que o site oficial;
• O visualizador de HTML deve projetar as tabelas de forma correta;

Anexos

N/A

Referências

N/A

Me parece muito bom 👍