Browse Source

new issue templates

Paolo Asperti 3 years ago
parent
commit
f6c5088aad

+ 4 - 1
.github/ISSUE_TEMPLATE/ask-a-question.md

@@ -2,9 +2,12 @@
2
 name: Ask a question
2
 name: Ask a question
3
 about: Ask the community for help
3
 about: Ask the community for help
4
 title: ''
4
 title: ''
5
-labels: question
5
+labels: 'question'
6
 assignees: ''
6
 assignees: ''
7
 
7
 
8
 ---
8
 ---
9
 
9
 
10
+This is the place for generic questions. Please stay on topic and be polite.
10
 
11
 
12
+**Notes**
13
+ - Please write in english only. If you provide some images in different languages, you're required to write a translation in english.

+ 16 - 21
.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
2
 name: Bug report
2
 name: Bug report
3
 about: Create a report to help us improve
3
 about: Create a report to help us improve
4
 title: ''
4
 title: ''
5
-labels: ''
5
+labels: 'bug'
6
 assignees: ''
6
 assignees: ''
7
 
7
 
8
 ---
8
 ---
@@ -10,29 +10,24 @@ assignees: ''
10
 **Describe the bug**
10
 **Describe the bug**
11
 A clear and concise description of what the bug is.
11
 A clear and concise description of what the bug is.
12
 
12
 
13
-**To Reproduce**
13
+**Describe the environment**
14
+ - Install environment: docker, docker swarm, podman, kubernetes, or package
15
+ - If available, the `docker-compose.yaml` file
16
+ - If package, we need the distribution and release: Ubuntu 22.04, Debian 11, ...
17
+ - Or if you're running the plain binary, how you're running it
18
+ - In any case, you have to specify the version in use
19
+
20
+**How to Reproduce the bug**
14
 Steps to reproduce the behavior:
21
 Steps to reproduce the behavior:
15
-1. Go to '...'
16
-2. Click on '....'
17
-3. Scroll down to '....'
18
-4. See error
22
+1. Given the previously described environment
23
+2. Do this and that
24
+3. I get this error
19
 
25
 
20
 **Expected behavior**
26
 **Expected behavior**
21
-A clear and concise description of what you expected to happen.
22
-
23
-**Screenshots**
24
-If applicable, add screenshots to help explain your problem.
25
-
26
-**Desktop (please complete the following information):**
27
- - OS: [e.g. iOS]
28
- - Browser [e.g. chrome, safari]
29
- - Version [e.g. 22]
30
-
31
-**Smartphone (please complete the following information):**
32
- - Device: [e.g. iPhone6]
33
- - OS: [e.g. iOS8.1]
34
- - Browser [e.g. stock browser, safari]
35
- - Version [e.g. 22]
27
+This should happen instead.
36
 
28
 
37
 **Additional context**
29
 **Additional context**
38
 Add any other context about the problem here.
30
 Add any other context about the problem here.
31
+
32
+**Notes**
33
+ - Please write in english only. If you provide some images in different languages, you're required to write a translation in english.

+ 1 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
1
+blank_issues_enabled: false

+ 6 - 3
.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,13 +2,13 @@
2
 name: Feature request
2
 name: Feature request
3
 about: Suggest an idea for this project
3
 about: Suggest an idea for this project
4
 title: ''
4
 title: ''
5
-labels: ''
5
+labels: 'enhancement'
6
 assignees: ''
6
 assignees: ''
7
 
7
 
8
 ---
8
 ---
9
 
9
 
10
 **Is your feature request related to a problem? Please describe.**
10
 **Is your feature request related to a problem? Please describe.**
11
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11
+A clear and concise description of what the problem is.
12
 
12
 
13
 **Describe the solution you'd like**
13
 **Describe the solution you'd like**
14
 A clear and concise description of what you want to happen.
14
 A clear and concise description of what you want to happen.
@@ -17,4 +17,7 @@ A clear and concise description of what you want to happen.
17
 A clear and concise description of any alternative solutions or features you've considered.
17
 A clear and concise description of any alternative solutions or features you've considered.
18
 
18
 
19
 **Additional context**
19
 **Additional context**
20
-Add any other context or screenshots about the feature request here.
20
+Add any other context about the feature request here.
21
+
22
+**Notes**
23
+ - Please write in english only. If you provide some images in different languages, you're required to write a translation in english.