Skip to content

Commit

Permalink
chore(ci): issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
alvarosabu committed May 14, 2024
1 parent df4852f commit 58a9fce
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: "\U0001F41E Bug Report"
description: Report an issue using Storyblok richtext resolver
labels: [pending-triage, pending-author]
body:
- type: markdown
attributes:
value: |
You're now going to fill out a bug report at the Storyblok richtext resolver. Thanks a lot for taking the time and let's make Storyblok open source projects better together!
- type: textarea
id: bug-description
attributes:
label: Describe the issue you're facing
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description so we can review it. Thanks in advance!
placeholder: My Storyblok richtext resolver configuration is ... ## Expected behavior ... ## Current Behavior ...
validations:
required: true
- type: input
id: reproduction
attributes:
label: Reproduction
description: Please provide a link to a repo or Stackblitz that can reproduce the issue you ran into. A minimal reproduction is required, if a report is vague or has no reproduction, it will receive a "need reproduction" label.
placeholder: Reproduction URL
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce
description: Please provide any reproduction steps that may need to be described.
placeholder: List the commands or configuration you set when you faced the error, and describe with process you follow to get the error.
- type: textarea
id: system-info
attributes:
label: System Info
description: Output of `npx envinfo --system --npmPackages '{ vue, @storyblok/*}' --binaries --browsers`
render: shell
placeholder: System, Binaries, Browsers, Vue 3 & Storyblok SDK version
validations:
required: true
- type: dropdown
id: package-manager
attributes:
label: Used Package Manager
description: Select the used package manager
options:
- npm
- yarn
- pnpm
validations:
required: true
- type: textarea
id: logs
attributes:
label: Error logs (Optional)
description: |
Optional if provided reproduction. Please copy and paste the log text.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Follow our [Code of Conduct](https://www.storyblok.com/trust-center#code-of-conduct?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
required: true
- type: markdown
attributes:
value: |
> This template was inspired by the [Vite issue template](https://github.com/vitejs/vite/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml)
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.fr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "\U0001F58C Feature Request"
description: Propose a feature or improvement that the Storyblok Rictext resolver should have
labels: [enhancement, pending-triage, pending-author]
body:
- type: markdown
attributes:
value: |
Thanks for helping us improve the Storyblok open source project, you rock!
- type: textarea
id: feature-description
attributes:
label: Description
description: "Clear and concise description of what you want to include or enhance from the package. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this feature request, tell us in the description so we can review and be aware of it. Thanks in advance!"
placeholder: As a developer using Storyblok richtext I want [wish] so that [benefit].
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Suggested solution or improvement
description: "Link to the PR or what implementation you will expect from us (links to external examples if needed)."
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context or screenshots about the feature request here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the feature request, please make sure you do the following
options:
- label: Follow our [Code of Conduct](https://www.storyblok.com/trust-center#code-of-conduct?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js-client)
required: true
- type: markdown
attributes:
value: |
> This template was inspired by the [Vite FR template](https://github.com/vitejs/vite/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml)

0 comments on commit 58a9fce

Please sign in to comment.