Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
broofa committed Jan 18, 2024
1 parent 533872a commit 3afe5aa
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,18 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

Low quality / low effort issues make me grumpy and cause me to respond in [ways I'm not proud of](https://github.com/uuidjs/uuid/issues/638#issuecomment-1152382769). So let's avoid that unpleasantness by having you do the following:

1. If your issue is related to a specific MIME type / extension, please verify the problem doesn't originate in [the mime-db project](https://github.com/jshttp/mime-db) (where this project gets it's data from)
2. Make the title descriptive, specific to your problem, and SEO-friendly.
3. If your issue involves an error message or stacktrace _of any sort_, PROVIDE AN [MRE](https://stackoverflow.com/help/minimal-reproducible-example)

I cannot emphasize that last point enough. A stacktrace or error message by itself is rarely helpful, you must include an MRE!

> "That MRE article is kinda long" / "I don't know how to make an MRE" / "Making an MRE is hard" / "I don't have time"

0 comments on commit 3afe5aa

Please sign in to comment.