mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-18 04:23:31 +01:00
docs: Add new issue form for applications (#9470)
This commit is contained in:
@@ -1,11 +1,13 @@
|
|||||||
name: Bug report
|
name: Bug report
|
||||||
description: Report incorrect or unexpected behavior of a package
|
description: Report an issue with discord.js or another package.
|
||||||
labels: [bug, need repro]
|
labels: [bug, need repro]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Use Discord for questions: https://discord.gg/djs
|
Thank you for filing an issue! If you are here to ask a question, use Discord instead: https://discord.gg/djs
|
||||||
|
|
||||||
|
This issue form is for discord.js, including other packages.
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: package
|
id: package
|
||||||
attributes:
|
attributes:
|
||||||
@@ -29,57 +31,44 @@ body:
|
|||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Issue description
|
label: Issue description
|
||||||
description: |
|
description: Describe the issue in as much detail as possible.
|
||||||
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: |
|
placeholder: |
|
||||||
Steps to reproduce with below code sample:
|
Steps to reproduce with below code sample:
|
||||||
1. do thing
|
1. Do thing
|
||||||
2. do thing in Discord client
|
2. Do thing in Discord client
|
||||||
3. observe behavior
|
3. Observe behavior
|
||||||
4. see error logs below
|
4. See error logs below
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: codesample
|
id: code_sample
|
||||||
attributes:
|
attributes:
|
||||||
label: Code sample
|
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 the package are you using? Run `npm list <package>` in your project directory and paste the output.
|
|
||||||
placeholder: We no longer support version 12 or earlier of discord.js
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: input
|
|
||||||
id: node-version
|
|
||||||
attributes:
|
|
||||||
label: Node.js version
|
|
||||||
description: |
|
description: |
|
||||||
Which version of Node.js are you using? Run `node --version` in your project directory and paste the output.
|
Your code sample should be:
|
||||||
If you are using TypeScript, please include its version (`npm list typescript`) as well.
|
1. Minimal - Use as little code as possible that still produces the same problem (and is understandable)
|
||||||
placeholder: Node.js version 16.9+ is required for version 14.0.0+
|
2. Complete - Provide all parts someone else needs to reproduce your problem
|
||||||
|
3. Reproducible - Test the code you're about to provide to make sure it reproduces the problem
|
||||||
|
|
||||||
|
This will be automatically formatted into code, so no need for backticks.
|
||||||
|
render: typescript
|
||||||
|
- type: textarea
|
||||||
|
id: versions
|
||||||
|
attributes:
|
||||||
|
label: Versions
|
||||||
|
description: List necessary versions here. This includes your package version, runtime version, operating system etc.
|
||||||
|
placeholder: |
|
||||||
|
- discord.js 14.9.0 (`npm ls discord.js` or another package)
|
||||||
|
- Node.js 16.9.0 (`node --version`)
|
||||||
|
- TypeScript 5.0.4 (`npm ls typescript` if you use it)
|
||||||
|
- macOS Ventura 13.3.1
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
|
||||||
id: os
|
|
||||||
attributes:
|
|
||||||
label: Operating system
|
|
||||||
description: Which OS does your application run on?
|
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: priority
|
id: priority
|
||||||
attributes:
|
attributes:
|
||||||
label: Priority this issue should have
|
label: Issue priority
|
||||||
description: Please be realistic. If you need to elaborate on your reasoning, please use the Issue description field above.
|
description: Please be realistic. If you need to elaborate on your reasoning, please use the issue description field above.
|
||||||
options:
|
options:
|
||||||
- Low (slightly annoying)
|
- Low (slightly annoying)
|
||||||
- Medium (should be fixed soon)
|
- Medium (should be fixed soon)
|
||||||
@@ -90,12 +79,9 @@ body:
|
|||||||
id: partials
|
id: partials
|
||||||
attributes:
|
attributes:
|
||||||
label: Which partials do you have configured?
|
label: Which partials do you have configured?
|
||||||
description: |
|
description: Check your `Client` constructor for the `partials` key.
|
||||||
Check your Client constructor for the `partials` key.
|
|
||||||
|
|
||||||
Tip: you can select multiple items
|
|
||||||
options:
|
options:
|
||||||
- Not applicable (subpackage bug)
|
- Not applicable
|
||||||
- No Partials
|
- No Partials
|
||||||
- User
|
- User
|
||||||
- Channel
|
- Channel
|
||||||
@@ -111,12 +97,9 @@ body:
|
|||||||
id: intents
|
id: intents
|
||||||
attributes:
|
attributes:
|
||||||
label: Which gateway intents are you subscribing to?
|
label: Which gateway intents are you subscribing to?
|
||||||
description: |
|
description: Check your `Client` constructor for the `intents` key.
|
||||||
Check your Client constructor options for the `intents` key.
|
|
||||||
|
|
||||||
Tip: you can select multiple items
|
|
||||||
options:
|
options:
|
||||||
- Not applicable (subpackage bug)
|
- Not applicable
|
||||||
- No Intents
|
- No Intents
|
||||||
- Guilds
|
- Guilds
|
||||||
- GuildMembers
|
- GuildMembers
|
||||||
@@ -141,7 +124,7 @@ body:
|
|||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: dev-release
|
id: dev_release
|
||||||
attributes:
|
attributes:
|
||||||
label: I have tested this issue on a development release
|
label: I have tested this issue on a development release
|
||||||
placeholder: d23280c (commit hash)
|
placeholder: d23280c (commit hash)
|
||||||
58
.github/ISSUE_TEMPLATE/02-application_bug_report.yml
vendored
Normal file
58
.github/ISSUE_TEMPLATE/02-application_bug_report.yml
vendored
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
name: Websites bug report
|
||||||
|
description: Report an issue with the documentation or guide websites.
|
||||||
|
labels: [bug, need repro]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filing an issue! If you are here to ask a question, use Discord instead: https://discord.gg/djs
|
||||||
|
|
||||||
|
This issue form is for our documentation and guide websites.
|
||||||
|
- type: dropdown
|
||||||
|
id: application
|
||||||
|
attributes:
|
||||||
|
label: Which application is this bug report for?
|
||||||
|
options:
|
||||||
|
- Documentation
|
||||||
|
- Guide
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Issue description
|
||||||
|
description: Describe the issue in as much detail as possible.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: steps_to_reproduce
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: What steps must be taken to reproduce this issue?
|
||||||
|
placeholder: |
|
||||||
|
1. Visit a page
|
||||||
|
2. Click a link
|
||||||
|
3. ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: versions
|
||||||
|
attributes:
|
||||||
|
label: Versions
|
||||||
|
description: List necessary versions here. This includes your browser, operating system etc.
|
||||||
|
placeholder: |
|
||||||
|
- Safari 16.4 (18615.1.26.11.23)
|
||||||
|
- macOS Ventura 13.3.1
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: priority
|
||||||
|
attributes:
|
||||||
|
label: Issue priority
|
||||||
|
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
|
||||||
@@ -9,11 +9,13 @@ body:
|
|||||||
We do not implement unreleased features.
|
We do not implement unreleased features.
|
||||||
Use Discord for questions: https://discord.gg/djs
|
Use Discord for questions: https://discord.gg/djs
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: package
|
id: application_or_package
|
||||||
attributes:
|
attributes:
|
||||||
label: Which package is this feature request for?
|
label: Which application or package is this feature request for?
|
||||||
options:
|
options:
|
||||||
- discord.js
|
- discord.js
|
||||||
|
- Documentation
|
||||||
|
- Guide
|
||||||
- brokers
|
- brokers
|
||||||
- builders
|
- builders
|
||||||
- collection
|
- collection
|
||||||
@@ -48,7 +50,7 @@ body:
|
|||||||
label: Alternative solutions or implementations
|
label: Alternative solutions or implementations
|
||||||
description: A clear and concise description of any alternative solutions or features you have considered.
|
description: A clear and concise description of any alternative solutions or features you have considered.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additional-context
|
id: additional_context
|
||||||
attributes:
|
attributes:
|
||||||
label: Other context
|
label: Other context
|
||||||
description: Any other context, screenshots, or file uploads that help us understand your feature request.
|
description: Any other context, screenshots, or file uploads that help us understand your feature request.
|
||||||
42
.github/issue-labeler.yml
vendored
42
.github/issue-labeler.yml
vendored
@@ -1,24 +1,42 @@
|
|||||||
|
apps:guide:
|
||||||
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nGuide\\n"
|
||||||
|
apps:website:
|
||||||
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nDocumentation\\n"
|
||||||
packages:brokers:
|
packages:brokers:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nbrokers'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nbrokers\\n"
|
||||||
packages:builders:
|
packages:builders:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nbuilders'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nbuilders\\n"
|
||||||
packages:collection:
|
packages:collection:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\ncollection'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\ncollection\\n"
|
||||||
packages:core:
|
packages:core:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\ncore'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\ncore\\n"
|
||||||
packages:discord.js:
|
packages:discord.js:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\ndiscord.js'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\ndiscord.js\\n"
|
||||||
packages:formatters:
|
packages:formatters:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nformatters'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nformatters\\n"
|
||||||
packages:next:
|
packages:next:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nnext'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nnext\\n"
|
||||||
packages:proxy:
|
packages:proxy:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nproxy'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nproxy\\n"
|
||||||
packages:proxy-container:
|
packages:proxy-container:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nproxy-container'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nproxy-container\\n"
|
||||||
packages:rest:
|
packages:rest:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nrest'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nrest\\n"
|
||||||
packages:voice:
|
packages:voice:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nvoice'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nvoice\\n"
|
||||||
packages:ws:
|
packages:ws:
|
||||||
- '### Which package is this (bug report|feature request) for\?\n\nws'
|
- "### Which (application|package|application or package) is this (bug
|
||||||
|
report|feature request) for\\?\\n\\nws\\n"
|
||||||
|
|||||||
@@ -88,7 +88,7 @@ export async function createPackage(packageName: string, packageDescription?: st
|
|||||||
|
|
||||||
const issueLabelerYAML = parseYAML(await readFile('issue-labeler.yml', 'utf8')) as Record<string, string[]>;
|
const issueLabelerYAML = parseYAML(await readFile('issue-labeler.yml', 'utf8')) as Record<string, string[]>;
|
||||||
issueLabelerYAML[`packages:${packageName}`] = [
|
issueLabelerYAML[`packages:${packageName}`] = [
|
||||||
`### Which package is this (bug report|feature request) for\\?\\n\\n${packageName}`,
|
`### Which (application|package|application or package) is this (bug report|feature request) for\\?\\n\\n${packageName}\\n`,
|
||||||
];
|
];
|
||||||
|
|
||||||
await writeFile('issue-labeler.yml', stringifyYAML(sortYAMLObject(issueLabelerYAML)));
|
await writeFile('issue-labeler.yml', stringifyYAML(sortYAMLObject(issueLabelerYAML)));
|
||||||
|
|||||||
Reference in New Issue
Block a user