Improve GitHub issue templates #6839
Conversation
| - type: input | ||
| attributes: | ||
| label: Guava Version |
There was a problem hiding this comment.
I put this at this position to be close to the "Packages" selection. But maybe it would be better to move it further up (maybe even as first field)?
There was a problem hiding this comment.
I think it might make sense to ask them to try the newest version before spending time on coming up with steps to repro the bug. Ideally all of the bugs we receive should be from the latest version so we don't waste time on bugs that have already been fixed. We might still want to record down the version number though so we could keep track of when the bug first appeared. It could help with debugging if we decide to visit old issues or if old bugs become relevant in new and unexpected ways.
There was a problem hiding this comment.
Maybe we can also add a (required?) checkbox to say something like
- This is currently the latest version of Guava available.
There was a problem hiding this comment.
Should this be part of the "Checklist" below then? Or / and should the description of the version field also mention this?
There was a problem hiding this comment.
The checkbox will show up in the issue once it's filed, so it might be a little weird to put it at the top. I think we can add some instructions at the top asking them to first make sure the bug is still present in the latest version. The checkbox can be at the bottom.
| - type: input | ||
| attributes: | ||
| label: Guava Version | ||
| description: Guava version for which you encountered the bug, for example `32.1.3-jre`. |
There was a problem hiding this comment.
The 32.1.3-jre is currently displayed a bit small by the GitHub UI:
Is that ok nonetheless, or should it for example be written as '32.1.3-jre'?
There was a problem hiding this comment.
We can move that into the placeholder of the input.
cpovirk
added
type=other
| @@ -9,7 +9,7 @@ body: | |||
|
|
|||
|
|
|||
| Be aware, though: most feature requests are not accepted, even if they're suggested by | |||
| a full-time Guava team member. [Feedback](http://stackoverflow.com/a/4543114/869736) from | |||
| a full-time Guava team member. [Feedback](https://stackoverflow.com/a/4543114) from | |||
There was a problem hiding this comment.
I copied all of these directly from the wiki, but yeah all of these should probably be https if possible. I'll update all of the links in the wiki as well.
| @@ -72,6 +79,7 @@ body: | |||
| - Java 8 | |||
| - Java 11 | |||
| - Java 17 | |||
| - Java 21 | |||
There was a problem hiding this comment.
I added these to match the platform= labels that we currently have, but yeah we should probably also have one for Java 21 by now.
| - type: input | ||
| attributes: | ||
| label: Guava Version |
There was a problem hiding this comment.
I think it might make sense to ask them to try the newest version before spending time on coming up with steps to repro the bug. Ideally all of the bugs we receive should be from the latest version so we don't waste time on bugs that have already been fixed. We might still want to record down the version number though so we could keep track of when the bug first appeared. It could help with debugging if we decide to visit old issues or if old bugs become relevant in new and unexpected ways.
| - type: input | ||
| attributes: | ||
| label: Guava Version |
There was a problem hiding this comment.
Maybe we can also add a (required?) checkbox to say something like
- This is currently the latest version of Guava available.
Also update some links that have been migrated. Context: #6839. RELNOTES=n/a PiperOrigin-RevId: 583401822
Also update some links that have been migrated. Context: #6839. RELNOTES=n/a PiperOrigin-RevId: 583401822
Also update some links that have been migrated. Context: #6839. RELNOTES=n/a PiperOrigin-RevId: 583431708
| - type: input | ||
| attributes: | ||
| label: Guava Version | ||
| description: Guava version for which you encountered the bug, for example `32.1.3-jre`. |
There was a problem hiding this comment.
We can move that into the placeholder of the input.
| - type: input | ||
| attributes: | ||
| label: Guava Version |
There was a problem hiding this comment.
The checkbox will show up in the issue once it's filed, so it might be a little weird to put it at the top. I think we can add some instructions at the top asking them to first make sure the bug is still present in the latest version. The checkbox can be at the bottom.
Tries to improve the GitHub issue templates, as originally suggested in the comments on #6785.
Please let me know if you want anything changed. Also, no worries if you don't want to implement these changes, I just wasn't sure whether anyone had seen my suggestions on #6785.