From 6e8657d047cad4621a4304a2d1b5b4b3342a06a0 Mon Sep 17 00:00:00 2001 From: Clament John Date: Thu, 7 Nov 2024 21:22:42 +0530 Subject: [PATCH 1/2] chore: Form based github issue templates --- .github/ISSUE_TEMPLATE/1.bug_report.yml | 79 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/2.feature_request.yml | 68 +++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 26 ------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- 4 files changed, 147 insertions(+), 46 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1.bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/2.feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml new file mode 100644 index 00000000..8b2d89c2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -0,0 +1,79 @@ +name: 'Bug Report' +description: 'Create a report to help us improve' +title: '[BUG] ' +labels: ['bug', 'triage'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: When I try to..., the error occurs... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: Minimal steps to reproduce the behavior (linking a repo with a reproduction will help for non trivial issues) + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. See error + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: input + id: opennext-version + attributes: + label: '@opennextjs/cloudflare version' + placeholder: '0.2.1' + validations: + required: true + + - type: input + id: node-version + attributes: + label: 'Node.js version' + placeholder: '18.x' + validations: + required: true + + - type: input + id: wrangler-version + attributes: + label: 'Wrangler version' + placeholder: '3.x' + validations: + required: true + + - type: textarea + id: next-info + attributes: + label: 'next info output' + description: 'Please run `next info` in your project directory and paste the output' + render: shell + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml new file mode 100644 index 00000000..2935e6a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2.feature_request.yml @@ -0,0 +1,68 @@ +name: 'Feature Request' +description: 'Suggest an idea for this project' +title: '[FEATURE] ' +labels: ['enhancement', 'triage'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest a new feature! Please fill out this form as completely as possible. + + - type: textarea + id: problem-description + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: | + I would like to see... + This would help by... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + placeholder: | + Alternative 1... + Alternative 2... + validations: + required: true + + - type: input + id: opennext-version + attributes: + label: '@opennextjs/cloudflare version' + description: What version of @opennextjs/cloudflare does this apply to? + placeholder: '0.2.1' + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Before submitting + description: Please confirm the following + options: + - label: I have checked that there isn't already a similar feature request + required: true + - label: This is a single feature (not multiple features in one request) + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 296b86c1..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug, triage -assignees: "" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Minimal steps to reproduce the behavior (linking a repo with a reproduction will help for non trivial issues): - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Environment (please complete the following information)** - -- @opennextjs/cloudflare version: -- Node version: -- wrangler version: -- `next info`: - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 7dfea368..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE]" -labels: enhancement, triage -assignees: "" ---- - -**Is your feature request related to a problem? Please describe** -A clear and concise description of what the problem is. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context about the feature here. -What @opennextjs/cloudflare version does this apply to? From ba44e0be51d360813d9a7cfa8d4c4ec879f7c3a1 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Fri, 8 Nov 2024 08:45:01 +0100 Subject: [PATCH 2/2] fixup! prettier --- .github/ISSUE_TEMPLATE/1.bug_report.yml | 28 ++++++++++---------- .github/ISSUE_TEMPLATE/2.feature_request.yml | 14 +++++----- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml index 8b2d89c2..1121071f 100644 --- a/.github/ISSUE_TEMPLATE/1.bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -1,13 +1,13 @@ -name: 'Bug Report' -description: 'Create a report to help us improve' -title: '[BUG] ' -labels: ['bug', 'triage'] +name: "Bug Report" +description: "Create a report to help us improve" +title: "[BUG] " +labels: ["bug", "triage"] body: - type: markdown attributes: value: | Thanks for taking the time to fill out this bug report! - + - type: textarea id: bug-description attributes: @@ -40,32 +40,32 @@ body: - type: input id: opennext-version attributes: - label: '@opennextjs/cloudflare version' - placeholder: '0.2.1' + label: "@opennextjs/cloudflare version" + placeholder: "0.2.1" validations: required: true - type: input id: node-version attributes: - label: 'Node.js version' - placeholder: '18.x' + label: "Node.js version" + placeholder: "18.x" validations: required: true - type: input id: wrangler-version attributes: - label: 'Wrangler version' - placeholder: '3.x' + label: "Wrangler version" + placeholder: "3.x" validations: required: true - type: textarea id: next-info attributes: - label: 'next info output' - description: 'Please run `next info` in your project directory and paste the output' + label: "next info output" + description: "Please run `next info` in your project directory and paste the output" render: shell validations: required: true @@ -76,4 +76,4 @@ body: label: Additional context description: Add any other context about the problem here. validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml index 2935e6a0..42704def 100644 --- a/.github/ISSUE_TEMPLATE/2.feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2.feature_request.yml @@ -1,7 +1,7 @@ -name: 'Feature Request' -description: 'Suggest an idea for this project' -title: '[FEATURE] ' -labels: ['enhancement', 'triage'] +name: "Feature Request" +description: "Suggest an idea for this project" +title: "[FEATURE] " +labels: ["enhancement", "triage"] body: - type: markdown attributes: @@ -42,9 +42,9 @@ body: - type: input id: opennext-version attributes: - label: '@opennextjs/cloudflare version' + label: "@opennextjs/cloudflare version" description: What version of @opennextjs/cloudflare does this apply to? - placeholder: '0.2.1' + placeholder: "0.2.1" validations: required: true @@ -65,4 +65,4 @@ body: - label: I have checked that there isn't already a similar feature request required: true - label: This is a single feature (not multiple features in one request) - required: true \ No newline at end of file + required: true