From 06fe49fca6bb65921c65c4b942c1dd75e8e77312 Mon Sep 17 00:00:00 2001 From: Tom Schraitle Date: Sun, 17 Nov 2024 11:40:04 +0100 Subject: [PATCH] Turn our Markdown templates into YAML The YAML format defines an issue form. This makes it (hopefully) easier to add more consistent bug reports. --- .github/ISSUE_TEMPLATE/bug_report.md | 33 --------- .github/ISSUE_TEMPLATE/bug_report.yaml | 82 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ------ .github/ISSUE_TEMPLATE/feature_request.yaml | 36 +++++++++ 4 files changed, 118 insertions(+), 57 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 461254e9..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us improve semver -title: '' -labels: bug -assignees: '' - ---- - - - -# Situation - - -# To Reproduce - - -# Expected Behavior - - -# Environment -- OS: [e.g. Linux, MacOS, Windows, ...] -- Python version [e.g. 3.6, 3.7, ...] -- Version of semver library [e.g. 3.0.0] - -# Additional context - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..a263dcb9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,82 @@ +name: 🐞Bug report +description: Create a bug report to help us improve +# title: '' +labels: [bug] +assignees: [tomschr] + +body: + - type: markdown + attributes: + value: | + Thanks a lot for taking the time to fill out this bug report! 🐛 + It will help us to improve the project for everyone. 🌟 + + Find help from the community on our [GitHub Discussions](https://github.com/python-semver/python-semver/discussions) page or + on our [Documentation](https://python-semver.readthedocs.io/en/latest/). + + - type: dropdown + id: python_version + attributes: + label: Which version of Python is the problem with? + multiple: true + options: + - "3.7" + - "3.8" + - "3.9" + - "3.10" + - "3.11" + - "3.12" + - "3.13" + - "3.14" + validations: + required: true + + - type: input + id: semver_version + attributes: + label: What semver version are you using? + description: You can find this with `pip show semver` + placeholder: 3.0.2 + + - type: dropdown + id: os + attributes: + label: What OS are you using? (Add more in the Environment section) + multiple: true + options: + - Linux + - Windows + - macOS + - Other + + - type: textarea + id: situation + attributes: + label: Situation + description: A clear and concise description of what the bug is. + placeholder: Describe the problem you see... + + - type: textarea + id: reproduction_steps + attributes: + label: How to reproduce + description: | + Steps to reproduce the behavior: + 1. Run '...' + 2. Scroll down to '....' + 3. See error + placeholder: Describe the steps to reproduce the issue... + + - type: textarea + id: expected_behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: Describe the expected behavior... + + - type: textarea + id: environment + attributes: + label: Environment + description: Optionally provide some more details about your environment. + placeholder: Describe your environment... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5a24681d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - - - -# Situation - - -# Possible Solution/Idea - - - -# Additional context - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..2ec54c11 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,36 @@ +name: Feature request +description: Suggest an idea for this project +# title: '' +labels: [enhancement] +assignees: [tomschr] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + + - type: textarea + id: situation + attributes: + label: Situation + description: A clear and concise description of what the feature is. Ex. I'm always frustrated when [...] + placeholder: Describe the situation... + validations: + required: true + + - type: textarea + id: expected_solution + attributes: + label: Expected solution + description: A clear and concise description of what you want to happen. + placeholder: Describe the expected solution... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: A clear and concise description of any alternative solutions or features you've considered. + placeholder: Describe any alternatives... \ No newline at end of file