Template
1
0
mirror of https://github.com/Wessel/boilerplate.git synced 2026-07-20 15:34:14 +02:00

feat: refresh boilerplate

This commit is contained in:
2023-02-07 22:21:22 +01:00
parent 674cb76595
commit bd491e1cb7
21 changed files with 633 additions and 285 deletions

View File

@@ -1,27 +0,0 @@
---
name: Bug Report
about: Report an issue with $(PROJECT_NAME)
title: "[BUG] Bug summed up in 1 sentence"
labels: bug
assignees: Wessel
---
**Please describe the problem you are having in as much detail as possible:**
**Include a reproducible code sample here, if possible:**
```js
// Place your code here
```
**Further details:**
- $(PROJECT_NAME) version:
- Node.js version:
- Operating system:
<!--
If this applies to you, please check the respective checkbox: [ ] becomes [x].
-->
- [ ] I have also tested the issue on latest master, commit hash:

78
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,78 @@
# Adapted from https://github.com/discordjs/discord.js/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml
name: Bug report
description: Report incorrect or unexpected behavior of a package
labels: [bug, need repro]
body:
# - type: markdown
# attributes:
# value: |
# Use Discord for questions: https://discord.gg/djs
- type: dropdown
id: package
attributes:
label: Which part is this bug report for?
options:
- {{tree.parts}}
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.
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: {{project.lang}}
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: version
attributes:
label: Version
description: Which version of the package are you using?
validations:
required: true
- type: input
id: lang-version
attributes:
label: {{project.lang}} version
description: |
Which version of {{project.lang}} are you using?
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: input
id: dev-release
attributes:
label: I have tested this issue on a development release
placeholder: d23280c (commit hash)
description: |
The issue might already be fixed in a development release or main. This is not required, but helps us greatly.

7
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,7 @@
blank_issues_enabled: false
# Example entry:
# name:
# url:
# about:
contact_links:
- {{project.contact}}

View File

@@ -1,20 +0,0 @@
---
name: Feature request
about: Request a feature for $(PROJECT_NAME)
title: "[ENHANCEMENT] Your idea"
labels: enhancement
assignees: Wessel
---
**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 ideal solution**
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.

View File

@@ -0,0 +1,42 @@
# Adapted from https://github.com/discordjs/discord.js/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml
name: Feature request
description: Request a new feature
labels: [feature request]
body:
- type: markdown
attributes:
value: |
Please only use this form for submitting new, original ideas.
- type: dropdown
id: package
attributes:
label: Which part is this feature request for?
options:
- {{tree.parts}}
validations:
required: false
- 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..., 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.