-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
chore: Update issue template to a form #7735
Conversation
Should we add fields for expected behavior and actual behavior? |
Codecov Report
@@ Coverage Diff @@
## main #7735 +/- ##
=======================================
Coverage 80.90% 80.90%
=======================================
Files 116 116
Lines 7457 7457
Branches 1806 1806
=======================================
Hits 6033 6033
Misses 1424 1424 Continue to review full report at Codecov.
|
The thought was that a good description would already include that. But we can add explicit fields too. |
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.
Should we add fields for expected behavior and actual behavior?
We did discuss this and as Ben says, the thinking was that those fields ought to be optional because most of the time it's pretty obvious. That said, if you have a counter-point, there's no reason we couldn't change that!
Mostly, that folks need to be pushed into putting in as much detail as possible, so, extra fields would be nice. That said, we can always add those in later on if we felt like this template isn't good enough. |
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.
Let's see how it goes with optional fields, but that's definitely a good point about reinforcing that we want as much info as possible.
We might want to consider some other issue types — would separate types for playback issues and general implementation issues be useful? Do we want a "feature request" template? Is no blank issue too strict?
Live example at https://github.com/mister-ben/issues-test-abc/issues/new/choose