Skip to content

Commit

Permalink
chore: add ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
  • Loading branch information
Timeless0911 committed May 31, 2024
1 parent 1d2ed6d commit d37b451
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.en-US.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "🐞 Bug Report"
description: Report a Bug to Rslib
title: "[Bug]: "
labels: ["🐞 bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this issue! Before submitting, please note:
- Confirm that your problem cannot be solved by official documentation.
- Make sure you searched in the [Issues](https://github.com/web-infra-dev/rslib/issues) and didn't find the same issue.
- If it's not bug report, please post on the [Discussions](https://github.com/web-infra-dev/rslib/discussions).
- type: textarea
id: versions
attributes:
label: Version
description: Run `npx envinfo --system --browsers --npmPackages '@rslib/*'` in your project, and paste the output into the textarea below.
placeholder: |
System:
Browsers:
npmPackages:
render: sh
validations:
required: true

- type: textarea
id: details
attributes:
label: Details
description: Please describe the Bug, including screenshots, etc.
validations:
required: true

- type: input
id: repro
attributes:
label: Reproduce link
description: "Please provide a simplest reproduction of the problem (minimal demo without redundant dependencies). You can create it on CodePen ([<kbd>⌘</kbd>Click here to open the template](https://codepen.io/Justineo/pen/yLbxxOR)), or provide the URL of the project:"
placeholder: paste link here
validations:
required: true

- type: textarea
id: reproduce-steps
attributes:
label: Reproduce Steps
description: Please provide the simplest steps so that we can quickly reproduce the problem.
placeholder: |
for example:
1. execute `pnpm dev`
2. find the error message in the console
validations:
required: true
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.en-US.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: "💡 Feature Request"
description: Submit a new feature request to Rslib
title: "[Feature]: "
labels: ["💡 feature"]
body:
- type: markdown
attributes:
value: |
Thanks for submitting new feature requests! Before submitting, please note:
- Confirmed that this is a common feature and cannot be implemented through existing APIs.
- Make sure you searched in the [Issues](https://github.com/web-infra-dev/rslib/issues) and didn't find the same request.
- You can discuss the feature in [Discussions](https://github.com/web-infra-dev/rslib/discussions) first.
- type: textarea
id: description
attributes:
label: What problem does this feature solve?
description: Please describe the usage scenario for this feature.
validations:
required: true

- type: textarea
id: api
attributes:
label: What does the proposed API look like?
description: Describe the new API, provide some code examples.
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/web-infra-dev/rslib/discussions
about: Ask a question about Rslib

0 comments on commit d37b451

Please sign in to comment.