Skip to content

Commit bb37897

Browse files
authored
chore: General repository touch-up (#152)
* docs: issue forms * chore: vanity * docs: redirect to own repository * chore: rename file
1 parent c12c103 commit bb37897

File tree

8 files changed

+91
-49
lines changed

8 files changed

+91
-49
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ a project may be further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at https://discord.gg/bRCvFy9. All
58+
reported by contacting the project team at https://discord.gg/djs. All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
6161
obligated to maintain confidentiality with regard to the reporter of an incident.

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @discordjs/opus Contributing Guide
22

3-
- [Code of Conduct](https://github.com/discordjs/discord.js-next/blob/master/.github/CODE_OF_CONDUCT.md)
3+
- [Code of Conduct](./CODE_OF_CONDUCT.md)
44
- [Pull Request Guidelines](#pull-request-guidelines)
55
- [Development Setup](#development-setup)
66

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Bug report
2+
description: Report an issue.
3+
labels: [bug, need repro]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for filing an issue! If you are here to ask a question, use Discord instead: https://discord.gg/djs
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Issue description
13+
description: Describe the issue in as much detail as possible.
14+
placeholder: |
15+
Steps to reproduce with below code sample:
16+
1. Do thing
17+
2. Do thing in Discord client
18+
3. Observe behavior
19+
4. See error logs below
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: code_sample
24+
attributes:
25+
label: Code sample
26+
description: |
27+
Your code sample should be:
28+
1. Minimal - Use as little code as possible that still produces the same problem (and is understandable)
29+
2. Complete - Provide all parts someone else needs to reproduce your problem
30+
3. Reproducible - Test the code you're about to provide to make sure it reproduces the problem
31+
32+
This will be automatically formatted into code, so no need for backticks.
33+
render: TypeScript
34+
- type: textarea
35+
id: versions
36+
attributes:
37+
label: Versions
38+
description: List necessary versions here. This includes your package version, runtime version, operating system etc.
39+
placeholder: |
40+
- @discordjs/opus xx.yy.zz (`npm ls @discordjs/opus`)
41+
- Node.js xx.yy.zz (`node --version`)
42+
- TypeScript xx.yy.zz (`npm ls typescript` if you use it)
43+
- macOS Ventura xx.yy.zz
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: priority
48+
attributes:
49+
label: Issue priority
50+
description: Please be realistic. If you need to elaborate on your reasoning, please use the issue description field above.
51+
options:
52+
- Low (slightly annoying)
53+
- Medium (should be fixed soon)
54+
- High (immediate attention needed)
55+
validations:
56+
required: true
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature request
2+
description: Request a new feature.
3+
labels: [feature request]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Feature
9+
description: A clear and concise description of what the problem is, or what feature you want to be implemented.
10+
placeholder: I'm always frustrated when..., Discord has recently released..., A good addition would be...
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: solution
15+
attributes:
16+
label: Ideal solution or implementation
17+
description: A clear and concise description of what you want to happen.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternative solutions or implementations
24+
description: A clear and concise description of any alternative solutions or features you have considered.
25+
- type: textarea
26+
id: additional_context
27+
attributes:
28+
label: Other context
29+
description: Any other context, screenshots, or file uploads that help us understand your feature request.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Errors upon installation
44
url: https://github.com/discordjs/opus/issues?q=is%3Aissue+error+install
5-
about: Most, if not all installation issues are due to lacking build dependencies. Please check other related issues before opening another.
5+
about: Most, if not all installation issues, are due to lacking build dependencies. Please check other related issues before opening another.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
**Please describe the changes this PR makes and why it should be merged:**
1+
## Description
22

3-
**Semantic versioning classification:**
3+
<!-- Please describe the changes this pull request makes and why it should be merged. -->
44

5-
- [ ] This PR changes the library's interface (methods or parameters added)
6-
- [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
7-
- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.
5+
- [ ] Code changes have been tested, or there are no code changes

0 commit comments

Comments
 (0)