Skip to content

Commit 49b905a

Browse files
committed
chore: improve issue templates
1 parent fc5c5d1 commit 49b905a

File tree

5 files changed

+140
-74
lines changed

5 files changed

+140
-74
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 51 deletions
This file was deleted.
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: Bug Report
2+
description: Create a report to help us improve Traefik Mesh.
3+
labels: ['status/0-needs-triage']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.**
9+
10+
The issue tracker is for reporting bugs and feature requests only.
11+
For end-user related support questions, please use the [Traefik Mesh community forum](https://community.traefik.io/c/traefik-mesh).
12+
13+
### How to write a good bug report?
14+
15+
- Respect the issue template as much as possible.
16+
- The title should be short and descriptive.
17+
- Explain the conditions which led you to report this issue: the context.
18+
- The context should lead to something, an idea or a problem that you’re facing.
19+
- Remain clear and concise.
20+
- 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)
21+
22+
- type: checkboxes
23+
id: terms
24+
attributes:
25+
label: Welcome!
26+
options:
27+
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/mesh/issues) and didn't find any.
28+
required: true
29+
- label: Yes, I've searched similar issues on the [Traefik Mesh community forum](https://community.traefik.io/c/traefik-mesh) and didn't find any.
30+
required: true
31+
32+
- type: textarea
33+
id: expect
34+
attributes:
35+
label: What did you expect to see?
36+
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
37+
placeholder: What did you expect to see?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: instead
43+
attributes:
44+
label: What did you see instead?
45+
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
46+
placeholder: What did you see instead?
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: version
52+
attributes:
53+
label: What version of Traefik Mesh are you using?
54+
description: |
55+
`latest` is not considered as a valid version.
56+
We need a release number!
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: controller
62+
attributes:
63+
label: Output of controller log
64+
placeholder: paste your output here
65+
render: shell
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: environment
71+
attributes:
72+
label: What is your environment & configuration?
73+
description: |
74+
arguments, YAML, TOML, provider, platform, etc.
75+
76+
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
77+
placeholder: Add information here.
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: objects
83+
attributes:
84+
label: If applicable, please paste the yaml objects required to reproduce your issue
85+
placeholder: Paste your objects here
86+
render: shell
87+
validations:
88+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ contact_links:
33
- name: Question
44
about: Please ask and answer questions here.
55
url: https://community.traefik.io/c/traefik-mesh
6-
6+
- name: Documentation
7+
url: https://doc.traefik.io/traefik-mesh/
8+
about: Please take a look to our documenation.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Feature Request
2+
description: Propose a change to Traefik Mesh!
3+
labels: ['status/0-needs-triage']
4+
body:
5+
- type: checkboxes
6+
id: terms
7+
attributes:
8+
label: Welcome!
9+
options:
10+
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/mesh/issues) and didn't find any.
11+
required: true
12+
- label: Yes, I've searched similar issues on the [Traefik Mesh community forum](https://community.traefik.io/c/traefik-mesh) and didn't find any.
13+
required: true
14+
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: Proposal
19+
description: |
20+
Write your feature request in the form of a proposal to be considered for implementation.
21+
22+
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
23+
placeholder: Write your feature request in the form of a proposal to be considered for implementation.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: background
29+
attributes:
30+
label: Background
31+
description: |
32+
Describe the background problem or need that led to this feature request.
33+
34+
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
35+
placeholder: Describe the background problem or need that led to this feature request.
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: workarounds
41+
attributes:
42+
label: Workarounds
43+
description: |
44+
Are there any current workarounds that you're using that others in similar positions should know?
45+
46+
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
47+
placeholder: Are there any current workarounds that you're using that others in similar positions should know?
48+
validations:
49+
required: true

0 commit comments

Comments
 (0)