It might be useful to have an ISSUE_TEMPLATE file that people fill out when submitting new Github Issues. Although it adds a slight PITA when submitting bug reports, it should help to avoid the common back-and-forth at the start of most issues to request useful information.

I have written one such template. The "Prerequisites" section is based on the most common missing/wrong things I've seen in submitted issues. Perhaps it belongs in a CONTRIBUTING file instead, but putting it inline in the ISSUE_TEMPLATE makes sure people have to explicitly ignore it.

For now don't worry about spelling or grammar mistakes, but I'm interested to see whether this is wanted at all, and whether any sections or items should be added or removed. We can get the exact spelling and wording fine-tuned when I make an actual pull request.

Feel free to try it out on my testing repository.


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or mute the thread.