From 3d80911785e28fa9161abb800f3e16be8df64eb8 Mon Sep 17 00:00:00 2001 From: Ed Harrod Date: Fri, 22 Nov 2024 14:28:32 +0200 Subject: [PATCH] .github: Add issue templates (#20) --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 54 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature-request.yml | 38 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 3 files changed, 93 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 0000000..14e7d56 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -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 \`\`\` tags, on separate lines before and after the text. (Use \`\`\`go to add Go syntax highlighting.) + If adding logs, please add them to a details section, so they can be toggled, e.g. `
Logslog lines...
`. + 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 diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 0000000..7af69c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false