From b4c1deeb51e52ae8f89833069f5cf865b882dc4d Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Thu, 18 Jan 2024 11:06:09 -0800 Subject: [PATCH] chore: update bug template (#301) --- .github/ISSUE_TEMPLATE.md | 6 ------ .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 6 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index a6c07b2..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,6 +0,0 @@ -### If you have an issue with a specific extension or type - -Locate the definition for your extension/type in the [db.json file](https://github.com/jshttp/mime-db/blob/master/db.json) in the `mime-db` project. Does it look right? - -- [ ] No. [File a `mime-db` issue](https://github.com/jshttp/mime-db/issues/new). -- [ ] Yes: Go ahead and submit your issue/PR here and I'll look into it. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a86f38d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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.