From bf23466154544902fc41ad7c7ebef71a077b627f Mon Sep 17 00:00:00 2001 From: Heinz-Alexander Fuetterer Date: Tue, 10 Dec 2024 21:39:14 +0100 Subject: [PATCH] chore: switch to issue forms --- .github/ISSUE_TEMPLATE/bug_report.md | 51 ----------------- .github/ISSUE_TEMPLATE/bug_report.yml | 65 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 30 ++++++++++ 4 files changed, 95 insertions(+), 75 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 9e49895..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve -labels: ['type: bug'] ---- - - - -## Description - - - -## Expected Behavior - - - -## Actual Behavior - - - -## Possible Fix - - - -## Steps to reproduce - - - -1. -2. -3. - -## Additional Context - - - -## Your Environment - - - -- Python version used (`python --version`): -- python-re3data version used (`python -m pip show python-re3data | grep "^Version:"`): -- Operating system and version: - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..9c398f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,65 @@ +name: Bug report +description: Create a bug report to help us improve +labels: ['type: bug'] + +body: +- type: markdown + attributes: + value: | + Thanks for taking the time to submit a bug report. Please provide a general summary of the issue in the Title above. +- type: textarea + attributes: + label: Description + description: Provide a more detailed introduction to the issue itself, and why you consider it to be a bug. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: Tell us what should happen. + validations: + required: false +- type: textarea + attributes: + label: Actual Behavior + description: Tell us what happens instead. + validations: + required: false +- type: textarea + attributes: + label: Possible Fix + description: Not obligatory, but suggest a fix or reason for the bug. + validations: + required: false + +- type: textarea + attributes: + label: Steps to reproduce + description: > + Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. + Include code to reproduce, if relevant. + placeholder: | + 1. + 2. + 3. + validations: + required: false +- type: textarea + attributes: + label: Additional Context + description: How has this bug affected you? What were you trying to accomplish? + validations: + required: false +- type: textarea + attributes: + label: Your Environment + description: Please tell us about your environment. Provide the output of the following commands. + value: | + - Python version used (`python --version`): + - python-re3data version used (`python -m pip show python-re3data | grep "^Version:"`): + - Operating system and version: + validations: + required: false + +# This issue template is adapted from: +# "open-source-templates", https://github.com/TalAter/open-source-templates (MIT License). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index d7d1e7f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -labels: ['type: feature'] ---- - - - -## Detailed Description - - - -## Context - - - - - -## Possible Implementation - - - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9e89f3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,30 @@ +name: Feature request +description: Suggest an idea for this project +labels: ['type: feature'] + +body: +- type: markdown + attributes: + value: | + Thanks for taking the time to submit a feature request. Please provide a general summary of the issue in the Title above. +- type: textarea + attributes: + label: Detailed Description + description: Provide a detailed description of the change or addition you are proposing. + validations: + required: true +- type: textarea + attributes: + label: Context + description: Why is this change important to you? How would you use it? How can it benefit other users? + validations: + required: false +- type: textarea + attributes: + label: Possible Implementation + description: Not obligatory, but suggest an idea for implementing addition or change. + validations: + required: false + +# This issue template is adapted from: +# "open-source-templates", https://github.com/TalAter/open-source-templates (MIT License).