From d37b4511c3ac5839d39b1be8147e655d174ce063 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=88=B4=E9=99=88=E5=A8=81?= Date: Fri, 31 May 2024 16:01:26 +0800 Subject: [PATCH] chore: add ISSUE_TEMPLATE --- .github/ISSUE_TEMPLATE/1-bug-report.en-US.yml | 55 +++++++++++++++++++ .../2-feature-request.en-US.yml | 29 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ 3 files changed, 89 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.en-US.yml create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.en-US.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.en-US.yml b/.github/ISSUE_TEMPLATE/1-bug-report.en-US.yml new file mode 100644 index 000000000..e42267e65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.en-US.yml @@ -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 ([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 diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.en-US.yml b/.github/ISSUE_TEMPLATE/2-feature-request.en-US.yml new file mode 100644 index 000000000..662ecd06b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.en-US.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..961d85fae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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