Skip to content

Commit 3d80911

Browse files
authored
.github: Add issue templates (#20)
1 parent 00bfcad commit 3d80911

File tree

3 files changed

+93
-0
lines changed

3 files changed

+93
-0
lines changed
+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug Report
2+
description: Report a bug that you are experiencing.
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
When reporting bugs, please follow the guidelines in this template. This helps identify the problem precisely and thus enables contributors to fix it faster.
9+
- Write a descriptive issue title above.
10+
- The golden rule is to **always open *one* issue for *one* bug**. If you notice several bugs and want to report them, make sure to create one new issue for each of them.
11+
- Ensure that you're on the latest release or commit on main. It's possible that the bug you're reporting has already been fixed in a more recent version of this package.
12+
- Search open and closed issues to ensure it has not already been reported. If you don't find a relevant match or if you're unsure, don't hesitate to **open a new issue**.
13+
14+
- type: textarea
15+
attributes:
16+
label: Tested Versions
17+
description: |
18+
To properly fix a bug, we need to identify if the bug was recently introduced, or if it was always present.
19+
- Please specify (if applicable) the release version you found the issue in, or the **Git commit hash** if pointing at the main branch.
20+
placeholder: |
21+
- Reproducible in: 1.1, 0511aa5.
22+
- Not reproducible in: b0ff83c2.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Issue Description
29+
description: |
30+
Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
31+
You can format code blocks or logs with <code>\`\`\`</code> tags, on separate lines before and after the text. (Use <code>\`\`\`go</code> to add Go syntax highlighting.)
32+
If adding logs, please add them to a details section, so they can be toggled, e.g. `<details><summary>Logs</summary>log lines...</details>`.
33+
Please do not add code examples or error messages as screenshots, but as text, this helps searching for issues and testing the code.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
attributes:
39+
label: Steps to Reproduce
40+
description: |
41+
List of steps or sample code that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them.
42+
If you include a minimal reproduction project below, you can detail how to use it here.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Minimal Reproduction Project (MRP)
49+
description: |
50+
- A small project which reproduces the issue, with no unnecessary files included.
51+
- Having an MRP is appreciated by contributors to be able to reproduce the bug in the same way that you are experiencing it. When testing a potential fix for the issue, contributors will use the MRP to validate that the fix is working as intended.
52+
- Drag and drop a ZIP archive to upload it (max 10 MB). **Do not select another field until the project is done uploading.**
53+
validations:
54+
required: false
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature Request
2+
description: Submit a feature request that will improve your experience.
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
When submitting feature requests, please follow the guidelines in this template - this helps contributors assess the request and determine if it's something that can and should be actioned.
9+
- Write a descriptive issue title above.
10+
- The golden rule is to **always open *one* issue for *one* feature request**. If you notice that your feature request actually consists of many independent features, make sure to create one new issue for each of them.
11+
- Ensure that you've taken a look at the latest release or commit on main. It's possible that the feature you're requesting has already been added in a more recent version of this package.
12+
- Search open and closed issues to ensure that the requested feature has not already been requested. If you don't find a relevant match or if you're unsure, don't hesitate to **open a new issue**.
13+
14+
- type: textarea
15+
attributes:
16+
label: Feature Description
17+
description: |
18+
Describe the feature you are requesting with as much detail as you can provide.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Rationale
25+
description: |
26+
Explain why this feature is something that you think will be a great addition to this package.
27+
- Please consider whether existing features can accomplish the goal you're trying to achieve. If not, explain why.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: Potential Solutions
34+
description: |
35+
List of ideas you may already have for the implementation of the feature you are requesting.
36+
- Please consider if you can make the contribution yourself. You don't even have to do everything yourself, other contributors will b more than happy to help out.
37+
validations:
38+
required: false

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)