Skip to content

Commit

Permalink
feat: created templates to issues and pull requests
Browse files Browse the repository at this point in the history
  • Loading branch information
migueloliveiradev authored Sep 7, 2024
1 parent fa7cbd7 commit ebf02d2
Show file tree
Hide file tree
Showing 5 changed files with 181 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Reportar bug
description: Reporte um problema ou comportamento diferente do esperado.
labels: ['bug']
body:
- type: markdown
attributes:
value: |
- Antes de abrir um novo issue, faça uma [pesquisa](https://github.com/migueloliveiradev/living/issues) para garantir que não está reportando um problema duplicado. Caso encontre um issue equivalente, contribua com informações adicionais, se necessário.
- Evite títulos genéricos ou vagos, como "Algo não está funcionando" ou "Alguns problemas" – seja o mais descritivo possível.
- Mantenha sua issue focado em um único problema. Se você tiver vários relatórios de bugs, crie uma issue separado para cada um deles.
- type: textarea
attributes:
label: Descrição
description: Que tipo de problema você encontrou? Por favor, descreva-o de forma clara e adicione imagens, se aplicável.
placeholder: |
Eu encontrei um problema na página de ... quando eu estava tentando...
O resultado foi esse:
![imagem](https://example.com/imagem)
validations:
required: true
- type: textarea
attributes:
label: Passos para reproduzir o problema
description: Quais são os passos necessários para que outra pessoa consiga encontrar o mesmo problema?
placeholder: |
1. Como usuário logado, acesse a página...
2. Clique em...
3. Faça...
4. Volte para ... e veja o erro.
validations:
required: true
- type: dropdown
attributes:
label: Navegadores testados
description: Em quais navegadores você percebeu esse problema?
multiple: true
options:
- Chrome
- Firefox
- Microsoft Edge
- Safari
- Outro
- type: textarea
attributes:
label: Possível solução
description: Você pensou em algo que pode resolver esse problema? Se sim, compartilhe abaixo.
placeholder: |
Ao invés de ... poderíamos mudar ... para...
Aqui está um exemplo de como ficaria:
![imagem](https://example.com/imagem)
- type: checkboxes
attributes:
label: Checklist
description: Lista rápida de verificações para garantir que tudo esteja em ordem.
options:
- label: Eu examinei as issues existentes para ter certeza de que esse bug não foi relatado antes
required: true
- label: Eu forneci um título descritivo para esta issue
required: true
- label: Eu forneci passo a passos claros e suficientes para essa issue
required: true
- label: Após melhor analise do bug descrito posso contribuir com um pull request
required: false
- label: Não li nenhum dos itens acima e apenas marquei todas as caixas para enviar a issue
required: false
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Sugerir novo recurso
description: Sugira um novo recurso, funcionalidade ou melhoria para o Projeto.
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Antes de abrir um novo issue, faça uma [pesquisa](https://github.com/migueloliveiradev/living/issues) para garantir que não está sugerindo algo duplicado. Caso encontre um issue equivalente, contribua com informações adicionais, se necessário.
- type: dropdown
attributes:
label: Tipo de recurso
description: Qual novo tipo de recurso desejado?
options:
- Melhoria em Layout
- Nova funcionalidade
- Codigo
- Outro
- type: textarea
attributes:
label: Descrição
description: O que você deseja melhorar ou adicionar? Por favor, descreva a sua sugestão e qual necessidade você tem hoje que essa sugestão resolveria.
placeholder: |
Eu acho que a página ... ficaria melhor se ... porque tive dificuldade em...
validations:
required: true
- type: textarea
attributes:
label: Sugestão de implementação
description: Você pensou em como isso poderia ser implementado? Compartilhe imagens, código ou referências que você considera úteis para a implementação dessa sugestão.
placeholder: |
Poderíamos mudar ... para acrescentar ... Fiz alguns desenhos de como isso poderia ficar:
![imagem](https://example.com/imagem)
- type: checkboxes
attributes:
label: Checklist
description: Lista rápida de verificações para garantir que tudo esteja em ordem.
options:
- label: Eu examinei as issues existentes para ter certeza de que esse recurso não foi sugerido antes
required: true
- label: Eu forneci um título descritivo para esse recurso
required: true
- label: Eu forneci uma sugestão de implementação para o recurso sugerido
required: false
- label: Após melhor analise do recurso sugerido posso contribuir com um pull request
required: false
- label: Não li nenhum dos itens acima e apenas marquei todas as caixas para enviar a issue
required: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/3_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Faça uma pergunta
description: Tem alguma dúvida sobre o repositório, código ou implementação de algo do Projeto? Faça uma pergunta.
labels: ['question']
body:
- type: markdown
attributes:
value: |
Antes de abrir um novo issue, faça uma [pesquisa](https://github.com/migueloliveiradev/living/issues) para ver se a sua dúvida já foi respondida.
- type: dropdown
attributes:
label: Assunto
description: Qual é o assunto da sua dúvida?
multiple: true
options:
- Funcionalidade
- API
- Código
- Repositório
- Contribuição
- Outro
validations:
required: true
- type: textarea
attributes:
label: Dúvida
description: Qual é a sua dúvida? Seja claro e coloque as informações relevantes para que outras pessoas consigam te ajudar.
placeholder: |
Eu não consegui entender como faço para...
validations:
required: true
- type: checkboxes
attributes:
label: Checklist
description: Lista rápida de verificações para garantir que tudo esteja em ordem.
options:
- label: Eu examinei as issues existentes para ter certeza de que essa duvida não foi enviada antes
required: true
- label: Eu forneci um título descritivo para essa duvida
required: true
- label: Eu encontrei uma questão semelhantes nas issues existentes, porém não foi suficiente para resolução da minha duvida
required: false
- label: Não li nenhum dos itens acima e apenas marquei todas as caixas para enviar a issue
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
25 changes: 25 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## O que foi feito?

<!-- Por favor, inclua uma descrição sobre o que foi modificado nesse pull request. Inclua também uma marcação a issue, todos pull requests devem ter menção a uma issue, caso não exista primeiro [crie](https://github.com/migueloliveiradev/living/issues/new) uma issue, após isso abra o pull request -->

<!-- Close #(issue) -->

<!-- Se o pull request contém uma modificação da interface gráfica (UI), adicione as paginas afetadas e fotos ou vídeos comparando o antes e depois. -->

<!-- Se o pull request contém modificações de BACKEND, mencione os endpoints afetados. -->

## Tipo de mudança

<!-- Descomente a linha abaixo que corresponde ao tipo de mudança realizada no pull request. -->

<!-- - [x] Correção de bug -->
<!-- - [x] Nova funcionalidade -->
<!-- - [x] Atualização de documentação -->


## Checklist:

- [ ] Eu segui a arquitetura e padronizações do projeto
- [ ] As modificações não geram novos logs de erro ou aviso (_warning_).
- [ ] Eu adicionei testes que provam que a correção ou novo recurso funciona conforme esperado, incluindo uma cobertura de testes para todos os possiveis caminhos de meu codigo
- [ ] Tanto os novos testes quanto os existentes estão passando localmente.

0 comments on commit ebf02d2

Please sign in to comment.