Shorten issue templates #20750
Shorten issue templates #20750
Conversation
| label: Detailed description | ||
| description: | | ||
| Context, boundary conditions, etc. Has this worked in earlier versions? | ||
| If possible: Root cause, suggested fix. |
There was a problem hiding this comment.
maybe make this a more information box instead to differentiate from description? I'm not sure what you're trying to elicit here that's not covered by description...maybe a why do you think this bug is happening?
label: More information
description: Any other information that may be helpful in understanding this bug
placeholder: |
* Has this worked before? anything different this time?
* What are the conditions under which this bug happens? input parameters, edge cases, etc?
* any theories about what's triggering this bug?suggested fixes is another field
There was a problem hiding this comment.
Taken over your suggestions (with some minor rewording) but in the description not in the placeholder.
| label: Detailed description | ||
| description: | | ||
| Context, boundary conditions, etc. Has this worked in earlier versions? | ||
| If possible: Root cause, suggested fix. | ||
| - type: input | ||
| id: operating-system | ||
| attributes: | ||
| label: Operating system |
There was a problem hiding this comment.
was gonna open a PR for this, but since you're tweaking - we should be consistent about capitalization in one direction or the other (all caps, sentence case)
|
Also on the dev docs the version isn't under the logo, so that part of the form should probably be changed too: |
|
Hmm, that's problematic; it's missing from anywhere visible if you aren't on the front page. |
|
The permanence of the version will be resolved in the theme by the version switcher pydata/pydata-sphinx-theme#433 (comment). Agreed that we have to adapt the wording. |
|
I think most suggestions are a question of style of the field descriptions: Do we want
I'm for the latter. I find the forms really off-putting. I wouldn't want to fill in many fields and then even read long context descriptions. The shorter the better. |
what about an alternative of clearer titles and explanations as part of the place holders. Basically I made everything imperative 'cause I didn't find the descriptions instructive. |
|
Clearer titles is definitively a win, where we can find them. E.g. I was trying to remove placeholders as much as possible. Maybe it's their style (the placeholder text color is quite strong), but I have the impression that fields with a placeholder are already filled in. And empty field visually calls to be filled, with a placeholder that's lost to me. |
fc3e686 to
8612661
Compare
|
@story645 I've mostly taken over your suggestions and kept the imperative style. |
Co-authored-by: hannah <story645@gmail.com>
8612661 to
88b5be9
Compare
PR Summary
Followup to #20688.
The goal is to make this as concise as possible.
Previews can be seen here: https://github.com/timhoffm/matplotlib/tree/doc-issue-template/.github/ISSUE_TEMPLATE