From 3afe5aab07aa0309a35d817e122175bc1f744bce Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Thu, 18 Jan 2024 08:35:01 -1000 Subject: [PATCH 1/2] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2c2dbb6 --- /dev/null +++ b/.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" From e1bcd0e85278ec9de08f60bd5b43c42f2360f39f Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Thu, 18 Jan 2024 09:04:40 -1000 Subject: [PATCH 2/2] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2c2dbb6..76be741 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,5 @@ --- name: Bug report -about: Create a report to help us improve title: '' labels: '' assignees: '' @@ -13,6 +12,20 @@ Low quality / low effort issues make me grumpy and cause me to respond in [ways 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! +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: -> "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" +| | | +|---|---| +| 🙂 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.