From 67e0eeff06ecbde3e8ae7c02dd8709671e01d203 Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Tue, 2 Apr 2024 08:26:49 -0700 Subject: [PATCH] new issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ------------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 34 +++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a86f38d..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..54574e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,34 @@ +name: Bug report +description: '`mime` support' + +body: + - type: checkboxes + attributes: + label: Idiot Checks&tm; + options: + - label: This is NOT about a specific MIME type ↔ extension. If it is, please search [the mime-project issues](https://github.com/jshttp/mime-db/issues). That's what this project uses, and there's a 99% chance your issue has already been raised there. + required: true + - label: The issue title is descriptive and specific to your problem (i.e. search-engine friendly) + required: true + - label: I know what an "MRE" is. If not, (read this)[https://stackoverflow.com/help/minimal-reproducible-example]" + required: true + + - type: input + attributes: + label: MRE (link) + description: URL to an MRE demonstrating your problem. This should be a project on StackBlitz, Codepen, or maybe CodeSandbox. A github repo is also acceptable, but not ideal. If you need a starting point, here's (a forkable-project on StackBlitz)[https://stackblitz.com/edit/mime-sample-mre?file=index.js] + placeholder: E.g. https://stackblitz.com/edit/mime-sample-mre?file=index.js + + - type: textarea + attributes: + label: MRE (supporting details) + description: Okay, I've opened your MRE link. Now what? + value: | + Actual behavior: ... + Expected behavior: ... + + - type: textarea + attributes: + label: 'Actually, let me just tell you about my problem ...' + description: | + This is a trap. If you need to use this field you're doing it wrong and this issue will be closed without comment.