Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.github: Add issue templates #20

Merged
merged 1 commit into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Bug Report
description: Report a bug that you are experiencing.

body:
- type: markdown
attributes:
value: |
When reporting bugs, please follow the guidelines in this template. This helps identify the problem precisely and thus enables contributors to fix it faster.
- Write a descriptive issue title above.
- 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.
- 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.
- 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**.

- type: textarea
attributes:
label: Tested Versions
description: |
To properly fix a bug, we need to identify if the bug was recently introduced, or if it was always present.
- Please specify (if applicable) the release version you found the issue in, or the **Git commit hash** if pointing at the main branch.
placeholder: |
- Reproducible in: 1.1, 0511aa5.
- Not reproducible in: b0ff83c2.
validations:
required: true

- type: textarea
attributes:
label: Issue Description
description: |
Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
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.)
If adding logs, please add them to a details section, so they can be toggled, e.g. `<details><summary>Logs</summary>log lines...</details>`.
Please do not add code examples or error messages as screenshots, but as text, this helps searching for issues and testing the code.
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: |
List of steps or sample code that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them.
If you include a minimal reproduction project below, you can detail how to use it here.
validations:
required: true

- type: textarea
attributes:
label: Minimal Reproduction Project (MRP)
description: |
- A small project which reproduces the issue, with no unnecessary files included.
- 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.
- Drag and drop a ZIP archive to upload it (max 10 MB). **Do not select another field until the project is done uploading.**
validations:
required: false
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature Request
description: Submit a feature request that will improve your experience.

body:
- type: markdown
attributes:
value: |
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.
- Write a descriptive issue title above.
- 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.
- 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.
- 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**.

- type: textarea
attributes:
label: Feature Description
description: |
Describe the feature you are requesting with as much detail as you can provide.
validations:
required: true

- type: textarea
attributes:
label: Rationale
description: |
Explain why this feature is something that you think will be a great addition to this package.
- Please consider whether existing features can accomplish the goal you're trying to achieve. If not, explain why.
validations:
required: true

- type: textarea
attributes:
label: Potential Solutions
description: |
List of ideas you may already have for the implementation of the feature you are requesting.
- 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.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false