Expand the bug issue template & add a template for questions#873
Expand the bug issue template & add a template for questions#873
Conversation
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.
Since I want to remove the blank issue option, we need to provide a template for questions.
Let's try to steer people towards the other issue forms, so that we are more likely to get the necessary information right from the start.
The previous sentence felt off, somehow. Hopefully this is better.
The order will be: 1. bugs 2. feature requests 3. questions 4. tasks
Edit the text, add placeholders, shuffle the question order, and basically overhaul all the templates.
| @@ -1 +1 @@ | |||
| blank_issues_enabled: true | |||
| blank_issues_enabled: false | |||
There was a problem hiding this comment.
Why no blank issues? I think it's nice if you have something that doesn't fit in another category for some reason.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 :-).
| 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> |
There was a problem hiding this comment.
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__)'
There was a problem hiding this comment.
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.
pavoljuhas
left a comment
pavoljuhas
left a comment
There was a problem hiding this comment.
Let us keep the blank issue in. Otherwise LGTM with a small optional suggestion.
The team wants blank issues enabled, so reverting changing the setting back to true.
OK, blank issue template re-enabled. |
3 participants
People are filing bug reports without providing us basic info like the qsim version. This PR revises the issue templates in the following ways:
After this change, there will be 4 templates: bug reports, feature requests, questions, and tasks.
Here is a screenshot of the revised bug template: