Skip to content

Commit b8365ff

Browse files
committed
Add issue templates using GitHub forms (quantumlib#1061)
This adds some forms for new issues and feature requests. They are essentially identical to the forms recently [added in the qsim repository](https://github.com/quantumlib/qsim/tree/master/.github/ISSUE_TEMPLATE).
1 parent ac5612b commit b8365ff

3 files changed

Lines changed: 81 additions & 0 deletions

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Bug report
2+
description: Report a problem with this software or project
3+
type: Bug
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this bug report!
9+
10+
- type: textarea
11+
attributes:
12+
label: Describe the issue
13+
description: >-
14+
Please explain clearly and in detail what the issue is. What led up
15+
to it, or how did you encounter it?
16+
validations:
17+
required: true
18+
19+
- type: input
20+
attributes:
21+
label: What version of this software are you using?
22+
validations:
23+
required: false
24+
25+
- type: textarea
26+
attributes:
27+
label: How can the issue be reproduced?
28+
description: >-
29+
Explain in a step-by-step fashion what someone else would need to
30+
do in order to reproduce the issue. If possible, include literal
31+
examples of commands or code using [Markdown fenced code
32+
blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
33+
For long output, paste the text into [collapsed
34+
sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
35+
or attach text files.
36+
validations:
37+
required: false
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature request
2+
description: Request a new feature or change
3+
type: Enhancement
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this feature request form!
9+
10+
- type: textarea
11+
attributes:
12+
label: Is your feature request related to a use case or problem?
13+
description: >-
14+
Please tell us the context of your request. Is it to help you do
15+
something that you currently cannot due to limitations in this
16+
software, or is it an idea for an enhancement or new functionality,
17+
or something else?
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: What solution or approach do you envision?
24+
description: >-
25+
If you have ideas or preferences for the solution, you can let us know
26+
here. If you are aware of other similar or related work, please let us
27+
know about it here.
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
attributes:
33+
label: How urgent is this for you?
34+
description: >-
35+
Please choose from among the following options. If the lack of this
36+
feature is blocking important work, please choose from among P0–P2.
37+
options:
38+
- P0 – needed no later than a week
39+
- P1 – needed by the next release
40+
- P2 – needed within two quarters
41+
- P3 – not blocked; it's an idea
42+
validations:
43+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

0 commit comments

Comments
 (0)