Skip to content

Commit c4ab057

Browse files
committed
chore: improve issue templates
1 parent 61bd6bf commit c4ab057

3 files changed

Lines changed: 236 additions & 85 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 91 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -7,74 +7,51 @@ body:
77
attributes:
88
label: Welcome
99
options:
10-
- label: Yes, I'm using a binary release within the two latest releases.
10+
- label: Yes, I'm using a binary release or the library within the two latest releases.
1111
required: true
1212
- label: Yes, I've searched for similar issues on GitHub and didn't find any.
1313
required: true
14-
- label: Yes, I've included all information below (version, config, etc).
15-
required: true
1614

17-
- type: textarea
18-
id: expected
15+
- type: markdown
1916
attributes:
20-
label: What did you expect to see?
21-
placeholder: Description.
22-
validations:
23-
required: true
17+
value: |
18+
#### Do you want your request to be released in a specific timeframe?
2419
25-
- type: textarea
26-
id: current
27-
attributes:
28-
label: What did you see instead?
29-
placeholder: Description.
30-
validations:
31-
required: true
20+
If it is possible to implement it, your request should be released (after implementation, review, and merge):
21+
22+
- In 1 week (7 days) maximum. Requires [High priority tier](https://github.com/sponsors/ldez/sponsorships?tier_id=605810).
23+
- In 2 days maximum. Requires [Critical priority tier](https://github.com/sponsors/ldez/sponsorships?tier_id=605811).
3224
3325
- type: dropdown
3426
id: type
3527
attributes:
3628
label: How do you use lego?
29+
# This is required because of a bug in Issue Forms:
30+
# The first option is always selected unless you are using the "multiple" attribute.
31+
multiple: true
3732
options:
38-
- I don't know
3933
- Library
4034
- Binary
4135
- Docker image
42-
- Through Traefik
36+
- go install
37+
- Through 1Panel
38+
- Through Bitnami
4339
- Through Caddy
40+
- Through Certimate
41+
- Through Dokku plugin
42+
- Through Home Assistant plugin
4443
- Through Terraform ACME provider
45-
- Through Bitnami
46-
- Through 1Panel
44+
- Through Traefik
4745
- Through Zoraxy
48-
- Through Certimate
49-
- go install
50-
- Other
51-
validations:
52-
required: true
53-
54-
- type: textarea
55-
id: steps
56-
attributes:
57-
label: Reproduction steps
58-
description: "How do you trigger this bug? Please walk us through it step by step."
59-
placeholder: |
60-
1. ...
61-
2. ...
62-
3. ...
63-
...
46+
- Other (please explain)
6447
validations:
6548
required: true
6649

67-
- type: textarea
50+
- type: input
6851
id: version
6952
attributes:
7053
label: Effective version of lego
71-
description: |-
72-
`latest` or `dev` are not effective versions.
73-
```console
74-
$ lego --version
75-
```
76-
placeholder: Paste output here
77-
render: console
54+
description: "`latest` or `dev` are NOT effective versions."
7855
validations:
7956
required: true
8057

@@ -93,6 +70,35 @@ body:
9370
validations:
9471
required: true
9572

73+
- type: textarea
74+
id: expected
75+
attributes:
76+
label: What did you expect to see?
77+
placeholder: Description.
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: current
83+
attributes:
84+
label: What did you see instead?
85+
placeholder: Description.
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
id: steps
91+
attributes:
92+
label: Reproduction steps
93+
description: "How do you trigger this bug? Please walk us through it step by step."
94+
placeholder: |
95+
1. ...
96+
2. ...
97+
3. ...
98+
...
99+
validations:
100+
required: true
101+
96102
- type: textarea
97103
id: go-env
98104
attributes:
@@ -108,3 +114,44 @@ body:
108114
</details>
109115
validations:
110116
required: false
117+
118+
- type: dropdown
119+
id: usage
120+
attributes:
121+
label: In which context are you using lego?
122+
# This is required because of a bug in Issue Forms:
123+
# The first option is always selected unless you are using the "multiple" attribute.
124+
multiple: true
125+
options:
126+
- Personal use
127+
- Professional use
128+
- Personal and professional use
129+
- Other (please explain)
130+
validations:
131+
required: true
132+
- type: checkboxes
133+
id: value-affirmation
134+
attributes:
135+
label: 🌱 Supporting the Maintainer
136+
options:
137+
- label: "Yes, I find this project useful, and it has saved me time in my workflow/business."
138+
required: false
139+
- label: "Yes, I have [starred](https://github.com/go-acme/lego) this repository to help others find it."
140+
required: false
141+
- label: "Yes, I have [sponsored](https://donate.ldez.dev) this project to keep the project stable and maintained."
142+
required: false
143+
144+
- type: markdown
145+
attributes:
146+
value: |
147+
Your support ensures this tool remains a reliable part of your toolkit for years to come.
148+
149+
[Support Project Longevity →](https://donate.ldez.dev)
150+
151+
- type: checkboxes
152+
id: validation
153+
attributes:
154+
label: Validation
155+
options:
156+
- label: Yes, I've included all the information above (version, usage, etc.).
157+
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 63 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,85 @@ body:
99
- label: Yes, I've searched for similar issues on GitHub and didn't find any.
1010
required: true
1111

12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Detailed Description
16+
placeholder: Description.
17+
validations:
18+
required: true
19+
20+
- type: input
21+
id: version
22+
attributes:
23+
label: Effective version of lego
24+
description: "`latest` or `dev` are NOT effective versions."
25+
validations:
26+
required: true
27+
1228
- type: dropdown
1329
id: type
1430
attributes:
1531
label: How do you use lego?
32+
# This is required because of a bug in Issue Forms:
33+
# The first option is always selected unless you are using the "multiple" attribute.
34+
multiple: true
1635
options:
17-
- I don't know
1836
- Library
1937
- Binary
2038
- Docker image
21-
- Through Traefik
39+
- go install
40+
- Through 1Panel
41+
- Through Bitnami
2242
- Through Caddy
43+
- Through Certimate
44+
- Through Dokku plugin
45+
- Through Home Assistant plugin
2346
- Through Terraform ACME provider
24-
- Through Bitnami
25-
- Through 1Panel
47+
- Through Traefik
2648
- Through Zoraxy
27-
- Through Certimate
28-
- go install
29-
- Other
49+
- Other (please explain)
3050
validations:
3151
required: true
3252

33-
- type: input
34-
id: version
53+
- type: dropdown
54+
id: usage
3555
attributes:
36-
label: Effective version of lego
37-
description: "`latest` or `dev` are not effective versions."
56+
label: In which context are you using lego?
57+
# This is required because of a bug in Issue Forms:
58+
# The first option is always selected unless you are using the "multiple" attribute.
59+
multiple: true
60+
options:
61+
- Personal use
62+
- Professional use
63+
- Personal and professional use
64+
- Other (please explain)
3865
validations:
3966
required: true
4067

41-
- type: textarea
42-
id: description
68+
- type: checkboxes
69+
id: value-affirmation
4370
attributes:
44-
label: Detailed Description
45-
placeholder: Description.
46-
validations:
47-
required: true
71+
label: 🌱 Supporting the Maintainer
72+
options:
73+
- label: "Yes, I find this project useful, and it has saved me time in my workflow/business."
74+
required: false
75+
- label: "Yes, I have [starred](https://github.com/go-acme/lego) this repository to help others find it."
76+
required: false
77+
- label: "Yes, I have [sponsored](https://donate.ldez.dev) this project to keep the project stable and maintained."
78+
required: false
79+
80+
- type: markdown
81+
attributes:
82+
value: |
83+
Your support ensures this tool remains a reliable part of your toolkit for years to come.
84+
85+
[Support Project Longevity →](https://donate.ldez.dev)
86+
87+
- type: checkboxes
88+
id: validation
89+
attributes:
90+
label: Validation
91+
options:
92+
- label: Yes, I've included all the information above (version, usage, etc.).
93+
required: true

0 commit comments

Comments
 (0)