Skip to content

Commit 861b690

Browse files
committed
Adiciona templates para Relatório de Bug e Solicitação de Recursos
- Cria um template para Relatório de Bug com os seguintes campos: - Termos de aceite - Descrição detalhada do problema - Expectativa versus observação - Capturas de tela/vídeos - Versão da API - Ambiente - Especificações adicionais do ambiente - Logs (se aplicável) - Notas adicionais - Cria um template para Solicitação de Recursos com os seguintes campos: - Termos de aceite - Tipo de recurso - Motivação para a solicitação - Exemplos de uso - Ideias de desenvolvimento - Notas adicionais
1 parent 05b5ae8 commit 861b690

File tree

8 files changed

+383
-132
lines changed

8 files changed

+383
-132
lines changed

.github/ISSUE_TEMPLATE/-en--bug-report.md

Lines changed: 0 additions & 38 deletions
This file was deleted.
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: Bug Report
2+
description: Create a report to help us improve.
3+
labels:
4+
- bug
5+
# - help wanted
6+
# Automatically assign the issue to:
7+
# assignees: DavidsonGomes
8+
body:
9+
- type: checkboxes
10+
id: terms
11+
attributes:
12+
label: Welcome!
13+
description: |
14+
The issue tracker is only for reporting bugs and feature requests.
15+
For user-related support questions, please visit:
16+
- [Discord](https://evolution-api.com/discord)
17+
- [WhatsApp Group](https://evolution-api.com/whatsapp)
18+
<br/>
19+
20+
**DO NOT OPEN AN ISSUE FOR GENERAL SUPPORT QUESTIONS.**
21+
22+
options:
23+
- label: Yes, I have searched for similar issues on [GitHub](https://github.com/EvolutionAPI/evolution-api/issues) and found none.
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: What did you do?
29+
description: |
30+
How to write a good bug report?
31+
32+
- Respect the issue template as much as possible.
33+
- The title should be short and descriptive.
34+
- Explain the conditions that led you to report this issue: the context.
35+
- The context should lead to something, an idea or problem you are facing.
36+
- Be clear and concise.
37+
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
38+
placeholder: Describe the problem you encountered in detail.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: What did you expect?
45+
placeholder: Describe what you expected to happen.
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: What did you observe instead of what you expected?
52+
placeholder: Explain what actually happens when you follow the steps above.
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
attributes:
58+
label: Screenshots/Videos
59+
placeholder: |
60+
If possible, add screenshots or videos that illustrate the problem. This can be extremely helpful in understanding the issue better.
61+
62+
- type: textarea
63+
attributes:
64+
label: Which version of the API are you using?
65+
description: |
66+
Enter the version number found in the `version` property of the **package.json**.
67+
placeholder: Paste the version here.
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: select
73+
attributes:
74+
label: What is your environment?
75+
options:
76+
- Windows
77+
- Linux
78+
- Mac
79+
- Docker
80+
- Other
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
attributes:
86+
label: Other environment specifications
87+
placeholder: 'Hardware/Software: [e.g., CPU, GPU]'
88+
validations:
89+
required: false
90+
91+
- type: textarea
92+
attributes:
93+
label: If applicable, paste the log output
94+
description: |
95+
Please attach any logs that might be related to the issue.
96+
If the logs contain sensitive information, consider sending them privately to one of the project maintainers.
97+
placeholder: Paste the application log here.
98+
validations:
99+
required: false
100+
101+
- type: textarea
102+
attributes:
103+
label: Additional Notes
104+
description: Include any other information you think might be useful to understand or resolve the bug.
105+
validations:
106+
required: false

.github/ISSUE_TEMPLATE/-en--feature-request.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Feature Request
2+
description: Suggest ideas for the project.
3+
labels:
4+
- enhancement
5+
# Automatically assign the issue to:
6+
# assignees: DavidsonGomes
7+
body:
8+
- type: checkboxes
9+
id: terms
10+
attributes:
11+
label: Welcome!
12+
description: '**DO NOT OPEN FOR GENERAL SUPPORT QUESTIONS.**'
13+
14+
options:
15+
- label: Yes, I have searched for similar requests on [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) and found none.
16+
required: true
17+
18+
- type: dropdown
19+
attributes:
20+
label: What type of feature?
21+
description: |
22+
How to write a good feature request?
23+
24+
- Respect the issue template as much as possible.
25+
- The title should be short and descriptive.
26+
- Explain the conditions that led you to suggest this feature: the context.
27+
- The context should lead to something, an idea or problem you are facing.
28+
- Be clear and concise.
29+
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
30+
options:
31+
- Integration
32+
- Functionality
33+
- Endpoint
34+
- Database adjustment
35+
- Other
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
attributes:
41+
label: What is the motivation for the request?
42+
description: |
43+
What problem does the feature seek to solve?
44+
Clearly and in detail describe the functionality you want to be implemented.
45+
Explain how it fits into the context of the project.
46+
placeholder: Detailed description
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
attributes:
52+
label: Usage Examples
53+
description: |
54+
Provide specific examples of how this functionality could be used.
55+
This can include scenarios or use cases where the feature would be particularly beneficial.
56+
placeholder: text - image - video - flowcharts
57+
validations:
58+
required: false
59+
60+
- type: textarea
61+
attributes:
62+
label: How should the feature be developed?
63+
description: |
64+
Should it be inserted directly into the code?
65+
Should it be built as a different application that acts as an extension of the API?
66+
For example: a `worker`?
67+
68+
Discuss how this new functionality could impact other parts of the project, if applicable.
69+
70+
---
71+
72+
If you have ideas on how this functionality could be implemented, please share them here.
73+
This is not mandatory, but it can be helpful for the development team.
74+
75+
placeholder: Insert feature ideas here
76+
validations:
77+
required: false
78+
79+
- type: textarea
80+
attributes:
81+
label: Additional Notes
82+
description: Any other information you believe is relevant to your request.
83+
placeholder: Insert your observations here.
84+
validations:
85+
required: false

.github/ISSUE_TEMPLATE/-pt--reportar-bug.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)