Skip to content

Commit 717c1c9

Browse files
committed
Ask for more information in bug reports
People are filing bug reports without providing us basic info like the qsim version. This adds an additional question to ask for the version number. It also adds a suggestion to search existing issues, and tweaks the form a little bit in other ways.
1 parent f69ef7d commit 717c1c9

1 file changed

Lines changed: 48 additions & 6 deletions

File tree

.github/ISSUE_TEMPLATE/1-bug-report.yml

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,75 @@ body:
55
- type: markdown
66
attributes:
77
value: |
8-
Thank you for taking the time to fill out this bug report!
8+
Thank you for making the effort to open an issue report. Before
9+
continuing, it's worth [searching through the existing issues in this
10+
repository](https://github.com/quantumlib/qsim/issues?q=is%3Aissue) in
11+
case the same issue has already been asked and possibly answered.
912
1013
- type: textarea
1114
attributes:
1215
label: Describe the issue
1316
description: >-
14-
Please explain clearly and in detail what the issue is. What led up
15-
to it, or how did you encounter it?
17+
Please explain clearly and in detail what the issue is. How did you
18+
encounter it? What were you trying to do?
1619
validations:
1720
required: true
1821

1922
- type: input
2023
attributes:
21-
label: What version of qsim are you using?
24+
label: Tell us the version of qsim or qsimcirq you are using
25+
description: >-
26+
If the problem involves a qsim/qsimcirq error or behavior, it is vital
27+
that we know the version installed in your computing environment. This
28+
can be determined in more than one way.
29+
30+
**In a terminal:**
31+
32+
If you are using the Python package (`qsimcirq`) and are running within
33+
a terminal emulator, then typing the following command in the shell will
34+
print the version number:
35+
36+
```shell
37+
python3 -c 'import qsimcirq; print(qsimcirq.__version__)'
38+
```
39+
40+
**In a Colab or Jupyter notebook:**
41+
42+
If you are using the `qsimcirq` package in a Google Colab or Jupyter
43+
notebook, then running the following command will print the version
44+
number:
45+
46+
```python
47+
import qsimcirq; print(qsimcirq.__version__)
48+
```
49+
validations:
50+
required: false
51+
52+
- type: input
53+
attributes:
54+
label: Tell us about the computing environment you are using
55+
description: >-
56+
To investigate the cause of the problem, we will also need to know the
57+
computing environment you are using. Please tell us if you are using
58+
Linux, macOS, Windows, Google Colab, or something else. If it is a
59+
Linux/Mac/Windows environment, please also tell us its version.
2260
validations:
2361
required: false
2462

2563
- type: textarea
2664
attributes:
27-
label: How can the issue be reproduced?
65+
label: Tell us how the issue can be reproduced
2866
description: >-
29-
Explain in a step-by-step fashion what someone else would need to
67+
Explain in a step-by-step fashion what someone else will need to
3068
do in order to reproduce the issue. If possible, include literal
3169
examples of commands or code using [Markdown fenced code
3270
blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
3371
For long output, paste the text into [collapsed
3472
sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
3573
or attach text files.
74+
placeholder: |
75+
1. …
76+
2. …
77+
3. …
3678
validations:
3779
required: false

0 commit comments

Comments
 (0)