Skip to content

Commit 24672bc

Browse files
authored
Add GitHub issue templates (#10)
2 parents 8225588 + c8d81b3 commit 24672bc

File tree

3 files changed

+129
-0
lines changed

3 files changed

+129
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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: input
31+
id: version
32+
attributes:
33+
label: Affected version(s)
34+
description:
35+
Please add a comma-separated list of the versions affected by this
36+
issue.
37+
placeholder: 'Example: v0.11.0, v0.12.0'
38+
- type: dropdown
39+
id: part
40+
attributes:
41+
label: Affected part(s)
42+
description:
43+
Which parts of the repo are affected by this issue? Select all that
44+
apply.
45+
multiple: true
46+
options:
47+
- I don't know (part:❓)
48+
- Documentation (part:docs)
49+
- Unit, integration and performance tests (part:tests)
50+
- Build script, CI, dependencies, etc. (part:tooling)
51+
- Battery power distribution (part:power-distribution)
52+
- Data pipeline (part:data-pipeline)
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: extra
57+
attributes:
58+
label: Extra information
59+
description:
60+
Please write here any extra information you think it might be relevant,
61+
e.g., if this didn't happen before, or if you suspect where the problem
62+
might be.
63+
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-sdk-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)