diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..6a12bfb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: Bug report +description: Report incorrect or unexpected behavior of a package +labels: [bug, need repro] +body: + - type: input + attributes: + label: Summary + description: A simple summary of your bug report + 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. 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: djs-version + attributes: + label: Package version + description: Which version of are you using? Run `npm list ` in your project directory and paste the output. + placeholder: You need to make sure you are using the latest version, older versions are not supported + 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 16.9+ is required for version 14.0.0+ + 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: checkboxes + attributes: + label: Checklist + description: > + Let's make sure this issue is valid! + options: + - label: I have searched the open issues for duplicates. + required: true + - label: I have shared the entire traceback. + required: true + - label: I am using a user token (and it isn't visible in the code). + required: true + - type: textarea + attributes: + label: Additional Information + description: Put any extra context, weird configurations, or other important info here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..f18fee9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discord.js Repo + url: https://github.com/discordjs/discord.js + about: A powerful JavaScript library for interacting with the Discord API [Bot]. \ 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 00000000..90ff204 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +name: Feature request +description: Request a new feature +labels: [feature request] +body: + - type: markdown + attributes: + value: | + We can only implement features that Discord publishes, documents and merges into the Discord API documentation. + For unreleased API features, you need more documents (Unofficial Discord API) or things you know. + - type: dropdown + id: package + attributes: + label: Which package is the feature request for? + options: + - The core library + - The documentation + 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