From f311574d1fb75039ea6cc595d0846a2e724dd1db Mon Sep 17 00:00:00 2001 From: Vlad Frangu Date: Sat, 15 Oct 2022 12:11:54 +0300 Subject: [PATCH] chore(GitHub): flashy new issue templates (#601) --- .github/ISSUE_TEMPLATE/bug_report.md | 25 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 83 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++ 4 files changed, 122 insertions(+), 46 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 88f4b62c..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Bug report -about: Report incorrect or unexpected behavior of discord-api-types -title: '' -labels: 'bug' -assignees: '' ---- - - - -**Please describe the problem you are having in as much detail as possible:** - -**Include a reproducible code sample here, if possible:** - -```ts -// Place your code here -``` - -**Further details:** - -- Runtime: - - - Node.js version: - - deno version: -- Priority this issue should have – please be realistic and elaborate if possible: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..2fa2c89f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,83 @@ +name: Bug report +description: Report incorrect or unexpected behavior of discord-api-types, or a mistyped type +labels: [bug] +body: + - type: markdown + attributes: + value: | + Use Discord for questions: https://discord.gg/djs + + - type: textarea + id: description + attributes: + label: Issue description + description: | + Please describe the problem you are having in as much detail as possible. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files into it. + placeholder: | + Steps to reproduce with below code sample: + 1. do thing + 2. it broke :c + validations: + required: true + + - type: textarea + id: codesample + attributes: + label: Code sample + description: Include a reproducible, minimal code sample. This will be automatically formatted into code, so no need for backticks. + render: typescript + placeholder: | + Your code sample should be... + ... Minimal - Use as little code as possible that still produces the same problem (and is understandable) + ... Complete - Provide all parts someone else needs to reproduce your problem + ... Reproducible - Test the code you're about to provide to make sure it reproduces the problem + + - type: input + id: types-version + attributes: + label: Package version + description: Which version of the package are you using? Run `npm list discord-api-types` in your project directory and paste the output. + validations: + required: true + + - type: dropdown + id: runtime + attributes: + label: Runtime + description: What runtime are you using? + options: + - Node.js + - Deno + - Bun + - Other / Browser + validations: + required: true + + - type: input + id: runtime-version + attributes: + label: Runtime version + description: | + Which version of your runtime of choice are you using? + If you are using TypeScript, please include its version (`npm list typescript`) as well. + placeholder: | + For Node.js: Run `node --version` in your project directory and paste the output. + For Deno: Run `deno --version` in your project directory and paste the output. + For Bun: Run `bun --version` in your project directory and paste the output. + For Other / Browser: Find the version in your runtime of choice and paste it here. + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: Priority this issue should have + description: Please be realistic. If you need to elaborate on your reasoning, please use the Issue description field above. + options: + - Low (slightly annoying) + - Medium (should be fixed soon) + - High (immediate attention needed) + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4a184563..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Request a feature for the discord-api-types library -title: '' -labels: 'discussion' -assignees: '' ---- - - - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Eg. I'm always frustrated when [...] - -**Describe the ideal solution** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..835bba2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature request +description: Request a feature for the discord-api-types library (we accept documented features of the official Discord developer API only!) +labels: [discussion] +body: + - type: markdown + attributes: + value: | + We will only only document types that Discord publishes, documents, and merges into the Discord API documentation. + We do not implement unreleased types, or types considered client only. + Use Discord for questions: https://discord.gg/djs + + - type: textarea + id: description + attributes: + label: Feature + description: A clear and concise description of what the problem is, or what feature you want to be implemented. + placeholder: I'm always frustrated when..., Discord has recently released..., A good addition would be... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Ideal solution or implementation + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternative solutions or implementations + description: A clear and concise description of any alternative solutions or features you have considered. + + - type: textarea + id: additional-context + attributes: + label: Other context + description: Any other context, screenshots, or file uploads that help us understand your feature request.