From a2ab5a7292c87d82cc28d17c552bbf4a233b5d60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Serna?= Date: Sat, 6 Aug 2022 01:44:49 -0300 Subject: [PATCH] Add ISSUE_TEMPLATE --- .github/ISSUE_TEMPLATE/bug-report.yml | 120 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.yml | 48 +++++++++ 3 files changed, 173 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..44b2d47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,120 @@ +name: Bug report +description: Report incorrect or unexpected behavior of a package +labels: [bug] +body: + - type: markdown + attributes: + value: | + Use Discord for questions: https://discord.com/invite/XNw2RZFzaP + - type: dropdown + id: package + attributes: + label: Which package is this bug report for? + options: + - core + - api-types + - cache + - rest + - helpers + - ws + validations: + required: true + - type: textarea + id: description + attributes: + label: Issue description + description: | + Describe the issue 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. do thing in Discord client + 3. observe behavior + 4. see error logs below + validations: + required: true + - type: textarea + id: codesample + attributes: + label: Code sample + description: Include a reproducible, minimal code sample. + 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: biscuit-version + attributes: + label: Package version + description: Which version of are you using? Run `npm list ` in your project directory and paste the output. + placeholder: We no longer support version 0.1.+ of biscuit + validations: + required: true + - type: input + id: node-version + attributes: + label: Node.js version + description: | + Which version of Node.js are you using? Run `node --version` in your project directory and paste the output. + If you are using TypeScript, please include its version (`npm list typescript`) as well. + placeholder: Node.js version 18.+ or 16.+ with experimental fetch is required to use this package + validations: + required: true + - type: input + id: os + attributes: + label: Operating system + description: Which OS does your application run on? + - 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 + - type: dropdown + id: intents + attributes: + label: Which gateway intents are you subscribing to? + description: | + Check your Client constructor options for the `intents` key. + + Tip: you can select multiple items + options: + - Not applicable (subpackage bug) + - No Intents + - Guilds + - GuildMembers + - GuildBans + - GuildEmojisAndStickers + - GuildIntegrations + - GuildWebhooks + - GuildInvites + - GuildVoiceStates + - GuildPresences + - GuildMessages + - GuildMessageReactions + - GuildMessageTyping + - DirectMessages + - DirectMessageReactions + - DirectMessageTyping + - MessageContent + - GuildScheduledEvents + multiple: true + validations: + required: true + - type: input + id: dev-release + attributes: + label: I have tested this issue on a development release + placeholder: commit hash + description: | + The issue might already be fixed in a development release or main. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..6a7a885 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discord server + url: https://discord.com/invite/XNw2RZFzaP + about: Please visit our Discord server for questions and support requests. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..92c20c2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,48 @@ +name: Feature request +description: Request a new feature for biscuit +labels: [feature request] +body: + - type: markdown + attributes: + value: | + We can only implement features that Discord publishes, documents and merges into the Discord API documentation or for our utility packages. + We do not implement unreleased features. + Use Discord for questions: https://discord.com/invite/XNw2RZFzaP + - type: dropdown + id: package + attributes: + label: Which package is the feature request for? + options: + - core + - api-types + - cache + - rest + - helpers + - ws + validations: + required: true + - 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. \ No newline at end of file