Skip to content

Commit b49779d

Browse files
authored
feat: add issue template
1 parent 4c339e1 commit b49779d

File tree

3 files changed

+107
-0
lines changed

3 files changed

+107
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Bug Report
2+
description: Create a report to help us improve.
3+
body:
4+
- type: checkboxes
5+
id: terms
6+
attributes:
7+
label: Welcome!
8+
description: |
9+
The issue tracker is for reporting bugs and feature requests only.
10+
11+
All new/updated issues are triaged regularly by the maintainers.
12+
All issues closed by a bot are subsequently double-checked by the maintainers.
13+
14+
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
15+
16+
options:
17+
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/whoami/issues) and didn't find any.
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: What did you do?
23+
description: |
24+
How to write a good bug report?
25+
26+
- Respect the issue template as much as possible.
27+
- The title should be short and descriptive.
28+
- Explain the conditions which led you to report this issue: the context.
29+
- The context should lead to something, an idea or a problem that you’re facing.
30+
- Remain clear and concise.
31+
- 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)
32+
placeholder: What did you do?
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: What were you expecting?
39+
placeholder: What were you expecting?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: What version are you using?
46+
description: |
47+
`latest` is not considered as a valid version.
48+
placeholder: Paste your output here.
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
attributes:
54+
label: What is your environment & configuration?
55+
description: arguments, toml, provider, platform, ...
56+
placeholder: Add information here.
57+
value: |
58+
```yaml
59+
# (paste your configuration here)
60+
```
61+
62+
Add more configuration information here.
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
attributes:
68+
label: If applicable, please paste the log output in DEBUG level
69+
description: "`--log.level=DEBUG` switch."
70+
placeholder: Paste your output here.
71+
validations:
72+
required: false

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Traefik Community Support
4+
url: https://community.traefik.io/
5+
about: If you have a question, or are looking for advice, please post on our Discuss forum! The community loves to chime in to help. Happy Coding!
+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project.
3+
body:
4+
- type: checkboxes
5+
id: terms
6+
attributes:
7+
label: Welcome!
8+
description: |
9+
The issue tracker is for reporting bugs and feature requests only.
10+
11+
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
12+
options:
13+
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/whoami/issues) and didn't find any.
14+
required: true
15+
16+
- type: textarea
17+
attributes:
18+
label: What did you expect to see?
19+
description: |
20+
How to write a good issue?
21+
22+
- Respect the issue template as much as possible.
23+
- The title should be short and descriptive.
24+
- Explain the conditions which led you to report this issue: the context.
25+
- The context should lead to something, an idea or a problem that you’re facing.
26+
- Remain clear and concise.
27+
- 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)
28+
placeholder: What did you expect to see?
29+
validations:
30+
required: true

0 commit comments

Comments
 (0)