mirror of
https://github.com/discordeno/discordeno.git
synced 2026-05-21 10:50:09 +00:00
feat(.github): new issue templates (#3166)
* feat: new issue templates * feat: add config yaml * feat: adding better example code * feat: add labels * Update .github/ISSUE_TEMPLATE/bug_report.yml * Update .github/ISSUE_TEMPLATE/bug_report.yml --------- Co-authored-by: ITOH <to@itoh.at>
This commit is contained in:
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,40 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe the bug** A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce** Write a small mod.ts example to replicate the behavior.
|
||||
|
||||
```ts
|
||||
import { createBot, startBot } from 'https://deno.land/x/discordeno/mod.ts'
|
||||
|
||||
const token = 'DO NOT PUT TOKEN HERE!!!'
|
||||
const botId = BigInt(atob(TOKEN.split('.')[0]))
|
||||
|
||||
const bot = createBot({
|
||||
token,
|
||||
botId,
|
||||
events: {
|
||||
// ADD EVENTS NEEDED TO SHOW THE BUG HERE
|
||||
},
|
||||
intents: 0, // ADD INTENTS NEEDED HERE FOR YOUR TEST IF NECESSARY
|
||||
})
|
||||
|
||||
await startBot(bot)
|
||||
```
|
||||
|
||||
**Expected behavior** A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots** If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Version details (please complete the following information):**
|
||||
|
||||
- Discordeno version: [e.g. 10.5.0]
|
||||
- Deno version: [e.g. 1.8.0]
|
||||
|
||||
**Additional context** Add any other context about the problem here.
|
||||
69
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
69
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
name: Bug Report
|
||||
description: Found a bug? Help us squash it.
|
||||
title: '[Bug]: '
|
||||
labels: ['t-bug', 'w-unverified']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for taking to the time to fill out a bug report. You make this library better for all! 🙏
|
||||
- type: dropdown
|
||||
id: runtime
|
||||
attributes:
|
||||
label: Runtime
|
||||
description: What runtime (Node, Deno, etc) are you using?
|
||||
options:
|
||||
- NodeJS
|
||||
- Deno
|
||||
- Bun
|
||||
- Other (add the name to the version)
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: runtime-version
|
||||
attributes:
|
||||
label: Runtime Version
|
||||
description: What version of the runtime are you using? In Node you could get this through `node --version`.
|
||||
placeholder: 18.3.1
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: dd-version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of Discordeno are you using?
|
||||
placeholder: 19.0.0
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: What is the outcome that you see that's unexpected? What steps should we take to reproduce the bug?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: bug-expectation
|
||||
attributes:
|
||||
label: What should've happened?
|
||||
description: If the bug didn't exist, what should've happened?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: bug-repro-code
|
||||
attributes:
|
||||
label: Code to reproduce the bug
|
||||
description: Provide us, if possible, a small piece of code that's easy to test to reproduce this specific bug.
|
||||
value: |
|
||||
import { createBot } from '@discordeno/bot'
|
||||
|
||||
const bot = createBot({
|
||||
token: process.env.TOKEN,
|
||||
events: {
|
||||
// Add the events, which are needed to show the bug
|
||||
},
|
||||
// Don't forget to add all necessary intents
|
||||
intents: 0,
|
||||
})
|
||||
bot.start()
|
||||
render: typescript
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Discordeno Discord
|
||||
url: https://discord.gg/ddeno
|
||||
about: Join our community and share your projects
|
||||
- name: Documentation
|
||||
url: https://discordeno.js.org/docs/intro
|
||||
about: Our documentation
|
||||
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,17 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: feat
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem
|
||||
is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like** 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.
|
||||
33
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
33
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
name: Feature Request
|
||||
description: Suggest an idea for this project
|
||||
title: '[Feat]: '
|
||||
labels: ['t-feat']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
We appreciate all feedback and suggestions for new features and look forward to hearing all about yours!
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Tell us what problem the feature would solve
|
||||
description: Provide as much information as possible and be descriptive, ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe the solution you'd like
|
||||
description: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe alternatives you've considered
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Info
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
validations:
|
||||
required: false
|
||||
Reference in New Issue
Block a user