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.

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

improve issue templates #883

Merged
merged 2 commits into from Apr 11, 2022
Merged

improve issue templates #883

merged 2 commits into from Apr 11, 2022

Conversation

achille-roussel
Copy link
Contributor

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

Copy link
Collaborator

@rhansen2 rhansen2 left a comment

Choose a reason for hiding this comment

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

LGTM

@achille-roussel achille-roussel merged commit 3049a65 into main Apr 11, 2022
@achille-roussel achille-roussel deleted the improve-issue-templates branch April 11, 2022 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants