Add issue template for bug reports. #2884
Conversation
This greatly helps the maintainers and contributors to understand and develop a solution to the bug described faster and helps the reporter write the report faster and in a more helpful way.
iddm
force-pushed
the
add-issue-template
branch
from
31dd428
to
fe88d5e
Compare
|
Really nice! |
| label: Code of Conduct | ||
| description: The Code of Conduct helps create a safe space for everyone. We require | ||
| that everyone agrees to it. | ||
| options: | ||
| - label: I have provided the minimal reproduction path. | ||
| required: true | ||
| - label: I have provided the relevant files via attachments (logs, stack traces, crash dumps, core-dumps, etc). | ||
| required: true | ||
| - label: I confirm the problem happens on another instance with the same state. | ||
| required: true |
There was a problem hiding this comment.
I find this section a bit too much to ask from the issue opener
There was a problem hiding this comment.
We would ask those questions anyway, wouldn't we? It is always good to know as fast as possible all of these answers. If it doesn't happen in another instance - it is really hard to reproduce, even with the minimal reproduction path. We almost always ask for the relevant files, be those logs, crash logs, core dump, or stack trace printed out. And without the minimal reproduction path, we will spend more time helping this very same person asking for help. And beside him, nobody knows how to minimise the problem better: nobody knows the internal structure of the graph(s), and nobody knows what would be the expected output given the circumstances. It is very standard practice even in much, much and much smaller open source projects. Nobody thinks it is too much to ask there, and I doubt it is too much to ask here. A good question is half the answer.
This greatly helps the maintainers and contributors to understand and develop a solution to the bug described faster and helps the reporter write the report faster and in a more helpful way.
Click to preview in my fork (1st stage - choosing).
Click to preview in my fork (2nd stage - filling).
Click to preview in my fork (3rd stage - filled example).
Feel free to comment and suggest changes.