Skip to content

Commit

Permalink
Merge pull request #4 from gitnnolabs/add_github_template
Browse files Browse the repository at this point in the history
Adiciona template para issues e pull request.
  • Loading branch information
gitnnolabs authored Jan 8, 2025
2 parents 8e62bd4 + 6efbf64 commit 8776d4a
Show file tree
Hide file tree
Showing 4 changed files with 166 additions and 0 deletions.
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/nova-funcionalidade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
name: Nova funcionalidade
about: Contribua com novas idéias e necessidades
title: ''
labels: enhancement
assignees: ''

---

### Descrição da nova funcionalidade
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
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/reportar-problema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Reportar problema
about: Reporte um erro ou problema e nos ajude a melhorar nossos produtos
title: ''
labels: bug
assignees: ''

---

### 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
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/tarefa-de-desenvolvimento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Tarefa de desenvolvimento
about: Tarefas definidas pelo próprio time de desenvolvimento
title: ''
labels: task
assignees: ''

---

### Descrição da tarefa
Descreva de forma clara e objetiva a tarefa em questão

### Subtarefas

- [ ] Descrição da primeira subtarefa
- [ ] Descrição da segunda subtarefa


## Considerações e notas

* A implementação destas mudanças implica em aumentar o consumo de disco..
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#### O que esse PR faz?

Check failure on line 1 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:1 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "#### O que esse PR faz?"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md

Check failure on line 1 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

First line in a file should be a top-level heading

.github/pull_request_template.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "#### O que esse PR faz?"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md041.md
Fale sobre o propósito do pull request como por exemplo: quais problemas ele soluciona ou quais features ele adiciona.

#### Onde a revisão poderia começar?

Check failure on line 4 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:4 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "#### Onde a revisão poderia começar?"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md
Indique o caminho do arquivo e o arquivo onde o revisor deve iniciar a leitura do código.

#### Como este poderia ser testado manualmente?

Check failure on line 7 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:7 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "#### Como este poderia ser testado manualmente?"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md
Estabeleça os passos necessários para que a funcionalidade seja testada manualmente pelo revisor.

#### Algum cenário de contexto que queira dar?

Check failure on line 10 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:10 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "#### Algum cenário de contexto que queira dar?"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md
Indique um contexto onde as modificações se fazem necessárias ou passe informações que contextualizam
o revisor a fim de facilitar o entendimento da funcionalidade.

### Screenshots

Check failure on line 14 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:14 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Screenshots"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md
Quando aplicável e se fizer possível adicione screenshots que remetem a situação gráfica do problema que o pull request resolve.

#### Quais são tickets relevantes?

Check failure on line 17 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:17 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "#### Quais são tickets relevantes?"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md
Indique uma issue ao qual o pull request faz relacionamento.

### Referências

Check failure on line 20 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / Check Markdown

Headings should be surrounded by blank lines

.github/pull_request_template.md:20 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Referências"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md022.md
Indique as referências utilizadas para a elaboração do pull request.

0 comments on commit 8776d4a

Please sign in to comment.