chore: improve issue template #4276
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rwgk
approved these changes
Oct 22, 2022
rwgk
reviewed
Oct 22, 2022
| The code should be minimal, have no external dependencies, isolate the | ||
| function(s) that cause breakage. Submit matched and complete C++ and | ||
| Python snippets that can be easily compiled and run to diagnose the | ||
| issue. If possible, make a PR with a new, failing test to give us a |
Collaborator
There was a problem hiding this comment.
How about:
In bold near the top: Note that a reproducer in a PR is much more likely to get immediate attention!
Near the top so that people think about their decision bug vs PR immediately.
Then repeat that sentence here, followed by: Failing tests in our CI give us the best starting point for working out fixes.
I could send a PR, plmk.
Collaborator
Author
There was a problem hiding this comment.
You can add to this one, I expect?
Collaborator
There was a problem hiding this comment.
Sorry that one had an accident. Fixed.
Collaborator
Author
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Small improvement to issue template, hopefully helping highlight regressions.