Skip to content

Commit

Permalink
chore: update bug template (#301)
Browse files Browse the repository at this point in the history
  • Loading branch information
broofa committed Jan 18, 2024
1 parent 533872a commit b4c1dee
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 6 deletions.
6 changes: 0 additions & 6 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: I'm eager to fix your problem... but only if it's my problem 🙃
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 in one of the following forms:

| | |
|---|---|
| 🙂 Acceptable | Code and instructions for reproducing the problem attached to your issue |
| 😃 Better | Code and instructions in a public repository |
| 🥳 Best | Project on a sandbox service such as [StackBlitz](https://stackblitz.com/), [CodePen](https://codepen.io/), or [CodeSandbox](https://codesandbox.com/) |

> "I don't have time to read that MRE article"
>
> "I don't have time to make an MRE"
>
> "I don't know how to make an MRE"
>
> "Making an MRE is hard"
Then don't bother creating an issue.

0 comments on commit b4c1dee

Please sign in to comment.