-
Notifications
You must be signed in to change notification settings - Fork 201
Expand the bug issue template & add a template for questions #873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
717c1c9
Ask for more information in bug reports
mhucka 2113668
Add a question template
mhucka 017daa4
Disable blank issues
mhucka a3fd96d
Tweak the initial comment
mhucka 368fce5
Shuffle the order to put questions as the 3rd option
mhucka 39f5376
Improve all the templates
mhucka 9883707
chore: merge branch
mhucka 913832f
Make the P0 text consistent between templates
mhucka e002072
Merge branch 'master' into mh-more-issue-template-work
mhucka 649baa6
Merge branch 'master' into mh-more-issue-template-work
mhucka 8773cf0
Merge branch 'master' into mh-more-issue-template-work
mhucka ecc4f86
Merge branch 'master' into mh-more-issue-template-work
mhucka 1766733
Merge branch 'master' into mh-more-issue-template-work
mhucka 0c1bea5
Tweak language of feature request
mhucka d61fa79
test
mhucka 912c178
test
mhucka 364dd55
Flip back the setting to allow blank issues
mhucka 964285a
Merge branch 'master' into mh-more-issue-template-work
mhucka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,66 @@ | ||
| name: Bug report | ||
| description: Report a problem with qsim or this project | ||
| type: Bug | ||
| 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> | ||
| ```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> | ||
| `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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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)
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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:
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:
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.