Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 41 additions & 11 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,63 @@ body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
Thank you for taking the time to open an issue report. Before
continuing, it's worth [searching through the existing issues in this
repository](https://github.com/quantumlib/qsim/issues?q=is%3Aissue) in
case the same topic has already been reported.

- type: textarea
attributes:
label: Describe the issue
description: >-
Please explain clearly and in detail what the issue is. What led up
to it, or how did you encounter it?
Please explain clearly and in detail what the issue is. What were you
trying to do? What happened? What was unexpected about what happened?
placeholder: >-
Describe the issue here
validations:
required: true

- type: input
attributes:
label: What version of qsim are you using?
validations:
required: false

- type: textarea
attributes:
label: How can the issue be reproduced?
label: Tell us how to reproduce the issue
description: >-
Explain in a step-by-step fashion what someone else would need to
Explain in a step-by-step fashion what someone else will need to
do in order to reproduce the issue. If possible, include literal
examples of commands or code using [Markdown fenced code
blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
For long output, paste the text into [collapsed
sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
or attach text files.
placeholder: >-
Write a step-by-step explanation of how to reproduce the issue here
validations:
required: false

- type: input
attributes:
label: Tell us the version of qsim or qsimcirq (if relevant)
description: |-
For qsim software problems, we need to know the exact version you are
using. If you are using the Python package and are running within a
terminal emulator, then typing the following command in the shell will
print the version number:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Copy link
Copy Markdown
Collaborator

@pavoljuhas pavoljuhas Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to use quoted textblock instead of nbsp-s here? (ie, the one below comes with a copy button)

python3 -c 'import qsimcirq; print(qsimcirq.__version__)'

Copy link
Copy Markdown
Collaborator Author

@mhucka mhucka Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you can imagine, that's the first thing I tried. Unfortunately, in issue forms, the copy button does not appear for code blocks:

image

Furthermore, in dark mode, IMHO it's much harder to see where you should write the answer because of the styling – specifically, the white code text attracts visual attention while the input box is harder to notice:

image

So, faced with these two facts, I looked for another solution and came up with the inline code + spacing approach you see in the final version.

`python3 -c 'import qsimcirq; print(qsimcirq.__version__)'`<br>
If you are using a Google Colab or Jupyter notebook environment,
then running the following command in a notebook cell will print
the version number:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
`import qsimcirq; print(qsimcirq.__version__)`
placeholder: >-
Write the qsim version number here
validations:
required: false

- type: input
attributes:
label: Tell us the computing environment (if relevant)
description: >-
Please tell us if you are using Linux, macOS, Windows, Google Colab, or
something else, and its version.
placeholder: >-
Describe the computing environment and its version here
validations:
required: false
22 changes: 15 additions & 7 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@ type: Enhancement
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this feature request form!
value: >-
Thank you for your interest in qsim! Before continuing, it's worth
[searching through the existing issues in this
repository](https://github.com/quantumlib/qsim/issues?q=is%3Aissue) in
case the same feature has already been requested.

- type: textarea
attributes:
label: Is your feature request related to a use case or problem?
label: What is your feature request?
description: >-
Please tell us the context of your request. Is it to help you do
something that you currently cannot due to limitations in qsim, or is it
an idea for an enhancement or new functionality, or something else?
Please describe the request and its context in detail. Is the feature
something that would help you do something that you currently cannot due
to limitations in qsim, or is it an idea for an enhancement or new
functionality, or something else?
placeholder: >-
Describe the feature request here
validations:
required: true

Expand All @@ -24,6 +30,8 @@ body:
If you have ideas or preferences for the solution, you can let us know
here. If you are aware of other similar or related work, please let us
know about it here.
placeholder: >-
Describe your proposed solution here
validations:
required: false

Expand All @@ -34,7 +42,7 @@ body:
Please choose from among the following options. If the lack of this
feature is blocking important work, please choose from among P0–P2.
options:
- P0 – needed no later than a week
- P0 – needed within two weeks
- P1 – needed by the next release
- P2 – needed within two quarters
- P3 – not blocked; it's an idea
Expand Down
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/3-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Question
description: As a question
type: Question
body:
- type: markdown
attributes:
value: >-
Thank you for your interest in qsim! Before continuing, it's worth
[searching through the existing issues in this
repository](https://github.com/quantumlib/qsim/issues?q=is%3Aissue) in
case the same question has already been asked and possibly answered.

- type: textarea
attributes:
label: What is the question?
description: >-
Please provide enough details and contextual information so that the
question is answerable.
placeholder: >-
Write your question here
validations:
required: true

- type: input
attributes:
label: Does this concern a specific version of qsim? If so, what version?
placeholder: >-
Write the qsim version number here
validations:
required: false

- type: input
attributes:
label: Is it specific to a computing environment? If so, which one?
description: >-
If the platform and operating system version may be relevant, please
tell us those details as well. It may matter, for example, whether you
are using Linux, macOS, Windows, or Google Colab, as well as whether
you are trying to use CUDA (and what version), and other details.
placeholder: >-
Describe the computing environment here
validations:
required: false
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,25 @@ type: Task
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this feature request form!
value: >-
Thank you for your interest in qsim! Before continuing, it's worth
[searching through the existing issues in this
repository](https://github.com/quantumlib/qsim/issues?q=is%3Aissue) in
case the same or similar task already exists.

- type: textarea
attributes:
label: What is the task?
placeholder: >-
Describe the task here
validations:
required: true

- type: textarea
attributes:
label: (Optional) Do you have ideas or preferences for the approach?
placeholder: >-
Describe a suggested or preferred approach here
validations:
required: false

Expand All @@ -26,7 +33,7 @@ body:
Please choose from among the following options. If the lack of this
feature is blocking important work, please choose from among P0–P2.
options:
- P0 – needed no later than a week
- P0 – needed within two weeks
- P1 – needed by the next release
- P2 – needed within two quarters
- P3 – not blocked; it's an idea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
blank_issues_enabled: true
blank_issues_enabled: false
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why no blank issues? I think it's nice if you have something that doesn't fit in another category for some reason.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an issue that someone filed when the previous forms were in place, and evidently they must have used the blank issue form, because the issue lacked almost any useful info or structure. That particular issue was a question, and the previous set of forms lacked one for questions, so I added one. After I did that, I couldn't think of something that didn't fit into the 4 categories that will exist after this PR is merged (i.e., bug, feature request, question, or task). That, in combination with the desire to steer inexperienced users away from using the blank form, made me think it was worth trying to limit issues to the 4 categories.

I don't feel very strongly about it. @dstrain115 can you think of issue types that don't fit in those 4 categories? If so, or if your past experience has been that blank issues are important to keep around, then we can keep them enabled.

Copy link
Copy Markdown
Collaborator Author

@mhucka mhucka Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A relevant point of comparison here is to the issue types for Cirq. The ones for Cirq overlap: "design discussion" is basically "feature request", and "project health issue" is a "bug". I'm not really sure there is value in distinguishing those that finely, to be honest.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The No Type Issues seems to be the most popular in the past issues. They can capture cases which are not a clear cut at the time of reporting - e.g., if qsim crashed after installation it could be due to incorrect action on the user side (ie, Question - how to install correctly) or because of genuine bug in qsim.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The No Type Issues seems to be the most popular in the past issues.

The qsim repo did not have any issue templates before I added the current ones earlier this year, which means the only issue type that people could select was the blank issue type. So of course, it looks like the most popular :-).

Loading