improve issue templates #883
Merged
Conversation
This file contains 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
achille-roussel
requested review from
dominicbarnes,
stevevls,
nlsun and
rhansen2
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.
I reviewed our issue template and thought we could provide a bit more structure to help users report issues in a format that would better support us.
If anything, adding formatted examples might be the main contribution here, as a lot of the submissions we receive have code blocks or logs pasted in standard text formatting, making it impractical for us to read.
I'm also hoping that encouraging users to submit a docker-compose file and fully functional Go program to reproduce the issue could help improve the quality of bug reports we receive. A first step in this the direction of #863