Skip to content

Commit 8eb0b60

Browse files
samuelveigarangelsamuelveigarangel
authored
Merge pull request #3 from samuelveigarangel/issue-1
Adiciona templates de Pull Request e Issue e configurações de .gitignore
2 parents 05be09d + 534822c commit 8eb0b60

File tree

7 files changed

+479
-0
lines changed

7 files changed

+479
-0
lines changed

‎.github/ISSUE_TEMPLATE/nova-funcionalidade.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
name: Nova funcionalidade
3+
about: Contribua com novas idéias e necessidades
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
### Descrição da nova funcionalidade
11+
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]**.
12+
13+
### Critérios de aceitação
14+
15+
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ê:
16+
- Ex 1: Fale sobre qual deve ser o comportamento da funcionalidade;
17+
- Ex 2: Fale sobre quais validações um formulário deve conter;
18+
- Ex 3: Fale sobre os tipos de impressão uma página deve suportar;
19+
- Ex 4: Fale sobre os tipos de usuários podem realizar a ação requisitada;
20+
- Critério 5;
21+
- Critério 6
22+
23+
### Anexos
24+
Este tópico é opcional mas pode ser utilizado para incluir objetos a serem analisados ou demonstrações que podem ser utilizados de exemplo.
25+
26+
### Referências
27+
Este tópico é opcional mas pode ser utilizado para enumerar items de referências como links ou bibliografia.
28+
29+
30+
----
31+
32+
# Exemplos
33+
34+
### 1) Descrição do requisito
35+
36+
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.
37+
38+
### Critérios de aceitação
39+
40+
Para que esta tarefa seja considerada concluída deve conter os seguintes pontos:
41+
- O botão de publicação deve possuir um tom vermelho que se destaque dos outros elementos de tela;
42+
- 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;
43+
- O botão deve ter conter um indicativo de "descrição de ação" ao posicionar o mouse e aguardar alguns segundos.
44+
45+
### Anexos
46+
N/A
47+
48+
### Referências
49+
N/A
50+
51+
---
52+
### 2) Descrição do requisito
53+
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.
54+
55+
### Critérios de aceitação
56+
57+
Os seguintes pontos devem ser contemplados:
58+
- Os botões de navegação nesta tela devem ser de fácil acesso e possuir fácil toque;
59+
- Os textos nesta tela devem possuir tamanho adequado para leitura seguindo os padrões da W3C;
60+
- Deve-se agrupar em blocos as seções de página para facilitar a navegabilidade;
61+
62+
### Anexos
63+
N/A
64+
65+
### Referências
66+
N/A
67+
68+
---
69+
### 3) Descrição do requisito
70+
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.
71+
72+
73+
### Critérios de aceitação
74+
75+
Os seguintes pontos devem ser contemplados:
76+
- O visualizador de HTML deve ser auto contido e não depender de internet;
77+
- O visualizador de HTML deve funcionar a partir do SPS 1.8;
78+
- O visualizador de HTML deve exibir o conteúdo da mesma forma que o site oficial;
79+
- O visualizador de HTML deve projetar as tabelas de forma correta;
80+
81+
### Anexos
82+
N/A
83+
84+
### Referências
85+
N/A

‎.github/ISSUE_TEMPLATE/reportar-problema.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Reportar problema
3+
about: Reporte um erro ou problema e nos ajude a melhorar nossos produtos
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Descrição do problema
11+
Descreva de forma clara e objetiva o problema relatado.
12+
13+
### Passos para reproduzir o problema
14+
1. Acesse a página ...
15+
2. Clique no link ...
16+
3. Role a página até ...
17+
4. Observe o erro apresentado
18+
19+
### Comportamento esperado
20+
Descreva com clareza qual seria o comportamento **esperado** (correto) ao reproduzir os passos acima.
21+
22+
### Screenshots ou vídeos
23+
Para dar mais detalhes e contexto sobre o erro, considere anexar fotos ou vídeos do problema.
24+
25+
### Anexos
26+
Está seção é opcional, utilize para referenciar arquivos que servem de insumo para reproduzir o erro, ex:
27+
- XML utilizado
28+
- HTML produzido
29+
- PDF criado
30+
31+
### Ambiente utilizado
32+
33+
Quando aplicável, forneça detalhes sobre o ambiente utilizado, ex:
34+
35+
- Navegador Mozilla Firefox versão 30
36+
- Windows XP
37+
- PC programs versão 1.0
38+
- Aparelho celular iPhone 7, iOS 7

‎.github/ISSUE_TEMPLATE/tarefa-de-desenvolvimento.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Tarefa de desenvolvimento
3+
about: Tarefas definidas pelo próprio time de desenvolvimento
4+
title: ''
5+
labels: task
6+
assignees: ''
7+
8+
---
9+
10+
### Descrição da tarefa
11+
Descreva de forma clara e objetiva a tarefa em questão
12+
13+
### Subtarefas
14+
15+
- [ ] Descrição da primeira subtarefa
16+
- [ ] Descrição da segunda subtarefa
17+
18+
19+
## Considerações e notas
20+
21+
* A implementação destas mudanças implica em aumentar o consumo de disco..

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#### O que esse PR faz?
2+
Fale sobre o propósito do pull request como por exemplo: quais problemas ele soluciona ou quais features ele adiciona.
3+
4+
#### Onde a revisão poderia começar?
5+
Indique o caminho do arquivo e o arquivo onde o revisor deve iniciar a leitura do código.
6+
7+
#### Como este poderia ser testado manualmente?
8+
Estabeleça os passos necessários para que a funcionalidade seja testada manualmente pelo revisor.
9+
10+
#### Algum cenário de contexto que queira dar?
11+
Indique um contexto onde as modificações se fazem necessárias ou passe informações que contextualizam
12+
o revisor a fim de facilitar o entendimento da funcionalidade.
13+
14+
### Screenshots
15+
Quando aplicável e se fizer possível adicione screenshots que remetem a situação gráfica do problema que o pull request resolve.
16+
17+
#### Quais são tickets relevantes?
18+
Indique uma issue ao qual o pull request faz relacionamento.
19+
20+
### Referências
21+
Indique as referências utilizadas para a elaboração do pull request.
22+

‎.github/dependabot.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Config for Dependabot updates. See Documentation here:
2+
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
3+
4+
version: 2
5+
updates:
6+
# Update GitHub actions in workflows
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
# Check for updates to GitHub Actions every weekday
10+
schedule:
11+
interval: "daily"
12+
13+
# Enable version updates for Docker
14+
# We need to specify each Dockerfile in a separate entry because Dependabot doesn't
15+
# support wildcards or recursively checking subdirectories. Check this issue for updates:
16+
# https://github.com/dependabot/dependabot-core/issues/2178
17+
- package-ecosystem: "docker"
18+
# Look for a `Dockerfile` in the `compose/local/django` directory
19+
directory: "compose/local/django/"
20+
# Check for updates to GitHub Actions every weekday
21+
schedule:
22+
interval: "daily"
23+
24+
# Enable version updates for Docker
25+
- package-ecosystem: "docker"
26+
# Look for a `Dockerfile` in the `compose/local/docs` directory
27+
directory: "compose/local/docs/"
28+
# Check for updates to GitHub Actions every weekday
29+
schedule:
30+
interval: "daily"
31+
32+
# Enable version updates for Docker
33+
- package-ecosystem: "docker"
34+
# Look for a `Dockerfile` in the `compose/local/node` directory
35+
directory: "compose/local/node/"
36+
# Check for updates to GitHub Actions every weekday
37+
schedule:
38+
interval: "daily"
39+
40+
# Enable version updates for Docker
41+
- package-ecosystem: "docker"
42+
# Look for a `Dockerfile` in the `compose/production/aws` directory
43+
directory: "compose/production/aws/"
44+
# Check for updates to GitHub Actions every weekday
45+
schedule:
46+
interval: "daily"
47+
48+
# Enable version updates for Docker
49+
- package-ecosystem: "docker"
50+
# Look for a `Dockerfile` in the `compose/production/django` directory
51+
directory: "compose/production/django/"
52+
# Check for updates to GitHub Actions every weekday
53+
schedule:
54+
interval: "daily"
55+
56+
# Enable version updates for Docker
57+
- package-ecosystem: "docker"
58+
# Look for a `Dockerfile` in the `compose/production/postgres` directory
59+
directory: "compose/production/postgres/"
60+
# Check for updates to GitHub Actions every weekday
61+
schedule:
62+
interval: "daily"
63+
64+
# Enable version updates for Docker
65+
- package-ecosystem: "docker"
66+
# Look for a `Dockerfile` in the `compose/production/traefik` directory
67+
directory: "compose/production/traefik/"
68+
# Check for updates to GitHub Actions every weekday
69+
schedule:
70+
interval: "daily"
71+
72+
# Enable version updates for Python/Pip - Production
73+
- package-ecosystem: "pip"
74+
# Look for a `requirements.txt` in the `root` directory
75+
# also 'setup.cfg', 'runtime.txt' and 'requirements/*.txt'
76+
directory: "/"
77+
# Check for updates to GitHub Actions every weekday
78+
schedule:
79+
interval: "daily"

‎.github/workflows/ci.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: CI
2+
3+
# Enable Buildkit and let compose use it to speed up image building
4+
env:
5+
DOCKER_BUILDKIT: 1
6+
COMPOSE_DOCKER_CLI_BUILD: 1
7+
8+
on:
9+
pull_request:
10+
branches: [ "master", "main" ]
11+
paths-ignore: [ "docs/**" ]
12+
13+
push:
14+
branches: [ "master", "main" ]
15+
paths-ignore: [ "docs/**" ]
16+
17+
concurrency:
18+
group: ${{ github.head_ref || github.run_id }}
19+
cancel-in-progress: true
20+
21+
jobs:
22+
linter:
23+
runs-on: ubuntu-latest
24+
steps:
25+
26+
- name: Checkout Code Repository
27+
uses: actions/checkout@v3
28+
29+
- name: Set up Python
30+
uses: actions/setup-python@v4
31+
with:
32+
python-version: "3.9"
33+
cache: pip
34+
cache-dependency-path: |
35+
requirements/base.txt
36+
requirements/local.txt
37+
38+
- name: Run pre-commit
39+
uses: pre-commit/action@v3.0.0
40+
41+
# With no caching at all the entire ci process takes 4m 30s to complete!
42+
pytest:
43+
runs-on: ubuntu-latest
44+
45+
steps:
46+
47+
- name: Checkout Code Repository
48+
uses: actions/checkout@v3
49+
50+
- name: Build the Stack
51+
run: docker-compose -f local.yml build
52+
53+
- name: Run DB Migrations
54+
run: docker-compose -f local.yml run --rm django python manage.py migrate
55+
56+
- name: Run Django Tests
57+
run: docker-compose -f local.yml run django pytest
58+
59+
- name: Tear down the Stack
60+
run: docker-compose -f local.yml down

0 commit comments

Comments
 (0)