-
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
Changes from 13 commits
717c1c9
2113668
017daa4
a3fd96d
368fce5
39f5376
9883707
913832f
e002072
649baa6
8773cf0
ecc4f86
1766733
0c1bea5
d61fa79
912c178
364dd55
964285a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 |
|---|---|---|
| @@ -1 +1 @@ | ||
| blank_issues_enabled: true | ||
| blank_issues_enabled: false | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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 :-). |
||
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.