|
8 | 8 | Thank you for taking the time to open an issue report. Before |
9 | 9 | continuing, it's worth [searching through the existing issues in this |
10 | 10 | repository](https://github.com/quantumlib/qsim/issues?q=is%3Aissue) in |
11 | | - case the same issue has already been asked and possibly answered. |
| 11 | + case the same topic has already been reported. |
12 | 12 |
|
13 | 13 | - type: textarea |
14 | 14 | attributes: |
15 | 15 | label: Describe the issue |
16 | 16 | description: >- |
17 | | - Please explain clearly and in detail what the issue is. How did you |
18 | | - encounter it? What were you trying to do? |
| 17 | + Please explain clearly and in detail what the issue is. What were you |
| 18 | + trying to do? What happened? What was unexpected about what happened? |
| 19 | + placeholder: >- |
| 20 | + Describe the issue here |
19 | 21 | validations: |
20 | 22 | required: true |
21 | 23 |
|
22 | | - - type: input |
| 24 | + - type: textarea |
23 | 25 | attributes: |
24 | | - label: Tell us the version of qsim or qsimcirq you are using |
| 26 | + label: Tell us how to reproduce the issue |
25 | 27 | 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 | | - ``` |
| 28 | + Explain in a step-by-step fashion what someone else will need to |
| 29 | + do in order to reproduce the issue. If possible, include literal |
| 30 | + examples of commands or code using [Markdown fenced code |
| 31 | + blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). |
| 32 | + For long output, paste the text into [collapsed |
| 33 | + sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) |
| 34 | + or attach text files. |
| 35 | + placeholder: >- |
| 36 | + Write a step-by-step explanation of how to reproduce the issue here |
49 | 37 | validations: |
50 | 38 | required: false |
51 | 39 |
|
52 | 40 | - type: input |
53 | 41 | 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. |
| 42 | + label: Tell us the version of qsim or qsimcirq (if relevant) |
| 43 | + description: |- |
| 44 | + For qsim software problems, we need to know the exact version you are |
| 45 | + using. If you are using the Python package and are running within a |
| 46 | + terminal emulator, then typing the following command in the shell will |
| 47 | + print the version number:<br> |
| 48 | + `python3 -c 'import qsimcirq; print(qsimcirq.__version__)'`<br> |
| 49 | + If you are using a Google Colab or Jupyter notebook environment, |
| 50 | + then running the following command in a notebook cell will print |
| 51 | + the version number:<br> |
| 52 | + `import qsimcirq; print(qsimcirq.__version__)` |
| 53 | + placeholder: >- |
| 54 | + Write the qsim version number here |
60 | 55 | validations: |
61 | 56 | required: false |
62 | 57 |
|
63 | | - - type: textarea |
| 58 | + - type: input |
64 | 59 | attributes: |
65 | | - label: Tell us how the issue can be reproduced |
| 60 | + label: Tell us the computing environment (if relevant) |
66 | 61 | description: >- |
67 | | - Explain in a step-by-step fashion what someone else will need to |
68 | | - do in order to reproduce the issue. If possible, include literal |
69 | | - examples of commands or code using [Markdown fenced code |
70 | | - blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). |
71 | | - For long output, paste the text into [collapsed |
72 | | - sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) |
73 | | - or attach text files. |
74 | | - placeholder: | |
75 | | - 1. … |
76 | | - 2. … |
77 | | - 3. … |
| 62 | + Please tell us if you are using Linux, macOS, Windows, Google Colab, or |
| 63 | + something else, and its version. |
| 64 | + placeholder: >- |
| 65 | + Describe the computing environment and its version here |
78 | 66 | validations: |
79 | 67 | required: false |
0 commit comments