Skip to content

Commit

Permalink
chore: Form based Github issue templates (#129)
Browse files Browse the repository at this point in the history
chore: Form based github issue templates
  • Loading branch information
clmnin authored Nov 8, 2024
1 parent 26509ca commit 8502d62
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 46 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/1.bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/2.feature_request.yml
Original file line number Diff line number Diff line change
@@ -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
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 8502d62

Please sign in to comment.