Skip to content

Commit 0e9d036

Browse files
Merge pull request #622 from jrCleber/main
Adiciona templates para Relatório de Bug e Solicitação de Recursos
2 parents 05b5ae8 + 8e19fe2 commit 0e9d036

File tree

8 files changed

+387
-132
lines changed

8 files changed

+387
-132
lines changed

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

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

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

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

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

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

0 commit comments

Comments
 (0)