From e4fb5432c7c0a5b881167e2818f5ad73e7ab0811 Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Mon, 4 Nov 2024 09:43:52 +0530 Subject: [PATCH] Refactor issue templates to issue forms --- .github/ISSUE_TEMPLATE/bug.md | 42 ------------- .github/ISSUE_TEMPLATE/bug.yml | 94 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 26 --------- .github/ISSUE_TEMPLATE/feature.yml | 58 ++++++++++++++++++ 4 files changed, 152 insertions(+), 68 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 09e78faa7..000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Nice, you found a bug! -title: '' -labels: 'bug' -assignees: 'shivammathur' - ---- - -**Describe the bug** - - -**Version** -- [ ] I have checked releases, and the bug exists in the latest patch version of `v1` or `v2`. -- [ ] `v2` -- [ ] `v1` - -**Runners** - -- [ ] GitHub Hosted -- [ ] Self Hosted - -**Operating systems** - - -**PHP versions** - - -**To Reproduce** - - -**Expected behavior** - - -**Screenshots/Logs** - - -**Additional context** - - -**Are you willing to submit a PR?** - diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..c640818eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,94 @@ +name: Bug report +description: Nice, you found a bug! +title: "Bug: " +labels: ["bug"] +assignees: ["shivammathur"] +body: + - type: markdown + attributes: + value: "Please fill out the sections below to help us address your issue." + + - type: textarea + id: bug-description + attributes: + label: "Describe the bug" + placeholder: "Please describe the bug concisely." + validations: + required: true + + - type: checkboxes + id: version + attributes: + label: "Version" + description: "I have checked releases, and the bug exists in the latest patch version of `v1` or `v2`." + options: + - label: "v2" + - label: "v1" + validations: + required: true + + - type: dropdown + id: runners + attributes: + label: "Runners" + description: "Please choose the GitHub Action runner your workflow uses." + options: + - "GitHub Hosted" + - "Self Hosted" + validations: + required: true + + - type: textarea + id: operating-systems + attributes: + label: "Operating systems" + placeholder: "e.g., Ubuntu 20.04, Windows Server 2019, etc." + validations: + required: true + + - type: textarea + id: php-versions + attributes: + label: "PHP versions" + placeholder: "e.g., PHP 7.4, PHP 8.0, etc." + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: "To Reproduce" + placeholder: "Please provide the relevant steps of your workflow `.yml` file." + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: "Expected behavior" + placeholder: "A clear and concise description of what you expected to happen." + validations: + required: true + + - type: textarea + id: screenshots-logs + attributes: + label: "Screenshots/Logs" + placeholder: "Drag and drop images or paste logs here..." + + - type: textarea + id: additional-context + attributes: + label: "Additional context" + placeholder: "Add any other context about the problem here." + + - type: dropdown + id: willing-to-submit-pr + attributes: + label: "Are you willing to submit a PR?" + description: "We accept pull requests targeting the develop branch." + options: + - "Yes" + - "No" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index c88e80706..000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest a new feature -title: '' -labels: 'enhancement' -assignees: 'shivammathur' - ---- - -**Describe the feature** - - -**Version** -- [ ] I have checked releases, and the feature is missing in the latest patch version of `v2`. - -**Underlying issue** - - -**Describe alternatives** - - -**Additional context** - - -**Are you willing to submit a PR?** - diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..82230800c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,58 @@ +name: Feature request +description: Suggest a new feature +title: "Feature: " +labels: ["enhancement"] +assignees: ["shivammathur"] +body: + - type: markdown + attributes: + value: "Please fill out the sections below to help us understand your new feature proposal." + + - type: textarea + id: feature-description + attributes: + label: "Describe the feature" + placeholder: "A clear and concise description of what you want and why." + validations: + required: true + + - type: checkboxes + id: version-check + attributes: + label: "Please check the latest release" + options: + - label: "I have checked releases, and the feature is missing in the latest patch version of `v2`." + required: true + + - type: textarea + id: underlying-issue + attributes: + label: "Underlying issue" + placeholder: "Please describe the issue this would solve." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives" + placeholder: "Please mention any alternative solutions you've considered." + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: "Additional context" + placeholder: "Drag and drop images or paste any additional information here..." + + - type: dropdown + id: willing-to-submit-pr + attributes: + label: "Are you willing to submit a PR?" + description: "We accept pull requests targeting the develop branch." + options: + - "Yes" + - "No" + validations: + required: true