Skip to content

Commit 8bae9b7

Browse files
committed
Add GitHub issue templates
Adds one template for reporting bugs, one for requesting new features and configure the template chooser to also point to the support forums. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent f9d093d commit 8bae9b7

File tree

3 files changed

+135
-0
lines changed

3 files changed

+135
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# GitHub issue form. For more information see:
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name: Report something is not working properly 🐛
5+
description:
6+
Use this if there is something that is not working properly. If you are not
7+
sure or you need help making something work, please ask a question instead.
8+
labels: priority:❓, type:bug
9+
body:
10+
- type: markdown
11+
attributes:
12+
value:
13+
Thanks for taking the time to fill out this bug report!
14+
- type: textarea
15+
id: what-happened
16+
attributes:
17+
label: What happened?
18+
description: Please tell us what happened that shouldn't have.
19+
placeholder: What happened that shouldn't have.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: what-expected
24+
attributes:
25+
label: What did you expect instead?
26+
description: Please tell us what did you expect to happen.
27+
placeholder: What did you expect to happen.
28+
validations:
29+
required: true
30+
- type: dropdown
31+
id: version
32+
attributes:
33+
label: Affected version(s)
34+
description:
35+
Which version(s) have you tried and found this issue in? (if you see
36+
this issue **not** happening on any version, please let us know in the
37+
"Extra information").
38+
multiple: true
39+
options:
40+
- I don't know (version:❓)
41+
- An older version (version:old)
42+
- v0.1.x (version:0.1.x)
43+
validations:
44+
required: true
45+
- type: dropdown
46+
id: part
47+
attributes:
48+
label: Affected part(s)
49+
description:
50+
Which parts of the repo are affected by this issue? Select all that
51+
apply.
52+
multiple: true
53+
options:
54+
- I don't know (part:❓)
55+
- Documentation (part:docs)
56+
- Unit, integration and performance tests (part:tests)
57+
- Build script, CI, dependencies, etc. (part:tooling)
58+
- Channels implementation (part:channels)
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: extra
63+
attributes:
64+
label: Extra information
65+
description:
66+
Please write here any extra information you think it might be relevant,
67+
e.g., if this didn't happened before, or if you suspect where the
68+
problem might be.
69+
placeholder: Any extra information you think it might be relevant.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GitHub issue template chooser. For more information see:
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
3+
4+
blank_issues_enabled: true
5+
contact_links:
6+
- name: Ask a question ❓
7+
url: https://github.com/frequenz-floss/frequenz-channels-python/discussions/new?category=support
8+
about: Use this if you are not sure how to do something, have installation problems, etc.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# GitHub issue form. For more information see:
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name: Request a feature or enhancement ✨
5+
description: Use this if something is missing or could be done better or more easily.
6+
labels: part:❓, priority:❓, type:enhancement
7+
body:
8+
- type: markdown
9+
attributes:
10+
value:
11+
Thanks for taking the time to fill out this feature or enhancement
12+
request!
13+
- type: textarea
14+
id: whats-needed
15+
attributes:
16+
label: What's needed?
17+
description:
18+
Please tell us what's missing or what could be done better or more easily.
19+
placeholder: What's missing or what could be done better or more easily.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed solution
26+
description:
27+
Please tell us how you think the needs above can be fulfilled. Only
28+
fill this field if it wasn't described above.
29+
placeholder:
30+
How do you think the needs above can be fulfilled. Only fill this field
31+
if it wasn't described above.
32+
- type: textarea
33+
id: use-cases
34+
attributes:
35+
label: Use cases
36+
description:
37+
Please tell us about the main use cases you see for this new feature or
38+
enhancement to help us understand more.
39+
placeholder:
40+
The main use cases you see for this new feature or enhancement to help
41+
us understand more.
42+
- type: textarea
43+
id: alternatives
44+
attributes:
45+
label: Alternatives and workarounds
46+
description:
47+
Please tell us if you tried any alternatives or workarounds for these
48+
use cases and how (un)useful they were.
49+
placeholder:
50+
Any alternatives or workarounds for these use cases and how (un)useful
51+
they were.
52+
- type: textarea
53+
id: additional-context
54+
attributes:
55+
label: Additional context
56+
description:
57+
Please add any additional information here - screenshots, diagrams, etc.
58+
placeholder: Any additional information here - screenshots, diagrams, etc.

0 commit comments

Comments
 (0)