Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve GitHub issue templates #6839

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve GitHub issue templates #6839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
View file
Open in desktop
Expand Up @@ -39,6 +39,13 @@ body:
validations:
required: true

- type: input
attributes:
label: Guava Version
Comment on lines +42 to +44
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@chaoren chaoren Nov 17, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can also add a (required?) checkbox to say something like

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be part of the "Checklist" below then? Or / and should the description of the version field also mention this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

description: Guava version for which you encountered the bug, for example `32.1.3-jre`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 32.1.3-jre is currently displayed a bit small by the GitHub UI:
GitHub issue forms screenshot

Is that ok nonetheless, or should it for example be written as '32.1.3-jre'?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can move that into the placeholder of the input.

validations:
required: true

- type: dropdown
attributes:
label: Packages
Expand Down Expand Up @@ -72,6 +79,7 @@ body:
- Java 8
- Java 11
- Java 17
- Java 21
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: checkboxes
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_addition_request.yaml
View file
Open in desktop
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

our users indicates that they really appreciate Guava's high power-to-weight ratio. It's
important to us to keep Guava as easy to use and understand as we can. That means boiling
features down to compact but powerful abstractions, and controlling feature bloat carefully.
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_enhancement_request.yaml
View file
Open in desktop
Expand Up @@ -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
our users indicates that they really appreciate Guava's high power-to-weight ratio. It's
important to us to keep Guava as easy to use and understand as we can. That means boiling
features down to compact but powerful abstractions, and controlling feature bloat carefully.
Expand Down