From fef427f1bc1922a2731762a224ccaad884d36960 Mon Sep 17 00:00:00 2001 From: Hiroki Osame Date: Fri, 11 Aug 2023 14:45:27 +0900 Subject: [PATCH] chore: improve issue template --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 133 ++++++++++++++------- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | 41 +++---- .github/ISSUE_TEMPLATE/config.yml | 6 +- 3 files changed, 116 insertions(+), 64 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index eca15b6..07d8b29 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -1,11 +1,30 @@ -name: Bug report -description: File a bug report +name: πŸ› Bug report +description: Run into a bug? File a report and get the help you need! labels: [bug, pending triage] body: - type: markdown attributes: value: | - Thank you for taking the time to file this bug report. + ## πŸ‘€ Tell us about the bug + A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem. + + - type: textarea + attributes: + label: Problem + placeholder: | + What did you do and what happened? + + Do you have an error stack trace? + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + placeholder: | + What did you expect to happen? + validations: + required: true - type: textarea attributes: @@ -24,63 +43,95 @@ body: validations: required: true - - type: input + - type: markdown attributes: - label: Minimal reproduction link - description: | - > ⚠️ A minimal reproduction is required to demonstrate the bug, and for us to debug it. If not provided, the issue will be closed. + value: | + ## πŸ“‹ Minimal reproduction + > ⚠️ If a minimal reproduction is not provided, **the issue will be closed.** + + The minimal reproduction proves a bug exists in this project, streamlines the conversation, and allows others to debug it for you right away. + + #### Requirements + 1. Create the reproduction on [StackBlitz](https://stackblitz.com) or a new GitHub repository so it can be opened in the browser. + 2. Keep the reproduction small. + Delete _everything_ you don't need. Narrowing the scope is the first step of debugging so doing this will save us work. + The _smaller_ the reproduction, the _faster_ we can debug and resolve your issue. - Provide a link to a minimal reproduction repository so we can `git clone`, run `npm start`, and reproduce the bug right away. + 3. No more than 10 files. + Delete irrelevant files (e.g. `LICENSE`, `.npmrc`, `.github`). + 4. Set the `start` script in `package.json` to the command that demonstrates the bug. Starter template: [fork this template on StackBlitz](https://stackblitz.com/edit/node-guv65j?file=webpack.config.js&view=editor) - #### Requirements: - - No more than 10 files - Delete irrelevant files (e.g. `LICENSE`, `.npmrc`, `.github`). This is the first step of debugging so doing this will save us work. - πŸ‘‰ **Tip:** The _smaller_ the reproduction, the _faster_ we can debug and resolve your issue + - type: input + attributes: + label: URL + placeholder: https://stackblitz.com/edit/... + validations: + required: true + + - type: markdown + attributes: + value: | + > **πŸ™‹ Experiencing a challenging bug and need expert assistance?** + > + > Get personalized help through my [_Priority Support_ service](https://github.com/sponsors/privatenumber). From minimal reproduction creation to debugging, I'm here to assist you! - - Set the `start` script in `package.json` to the command that shows the bug + - type: markdown + attributes: + value: "## 🌍 Environment" - placeholder: Minimal reproduction URL + - type: input + attributes: + label: Version + placeholder: v0.0.0 validations: required: true - - type: textarea + - type: input attributes: - label: Environment - description: | - Run and paste the output of: - ``` - npx envinfo --system --npmPackages webpack,esbuild-loader --binaries - ``` - - This information is used to for reproduction and debugging. - placeholder: | - System: - OS: - CPU: - Shell: - Binaries: - Node: - npm: - npmPackages: - webpack: - esbuild-loader: - render: shell + label: Node.js version + placeholder: v0.0.0 validations: required: true + - type: dropdown + id: package-manager + attributes: + label: Package manager + options: + - npm + - yarn + - pnpm + - bun + - N/A + validations: + required: true + + - type: dropdown + attributes: + label: Operating system + options: + - macOS + - Windows + - Linux + validations: + required: true + + - type: markdown + attributes: + value: "## πŸ› οΈ Can you contribute a fix?" + - type: checkboxes attributes: - label: Can you contribute a fix? - description: We would love it if you can open a pull request to fix this bug! + label: It would be amazing if you can contribute to the project! options: - - label: I’m interested in opening a pull request for this issue. + - label: I plan to open a pull request for this issue. - type: markdown attributes: value: | - #### Seeking priority support? - Escalate this issue by becoming a [sponsor](https://github.com/sponsors/privatenumber)! As a sponsor, your concern will receive prompt attention, ensuring faster and more efficient resolution. + ## πŸš€ Need immediate attention? + Escalate this issue by becoming a [_Priority Patron_ sponsor](https://github.com/sponsors/privatenumber)! As a _Priority Patron_, your concern will receive prompt attention, ensuring faster and more efficient resolution. - [πŸ‘‰ Get priority support now!](https://github.com/sponsors/privatenumber) + [πŸ‘‰ Become a _Priority Patron_ now!](https://github.com/sponsors/privatenumber) diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml index 5d04588..7cfd945 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -1,31 +1,27 @@ -name: Feature request -description: Suggest an idea for this project -labels: [feature request, pending triage] +name: 🌟 Feature request +description: Have a great idea for this project? Tell us more! +labels: [enhancement, pending triage] body: - type: markdown attributes: - value: | - Thank you for taking the time to file this feature request. + value: "## πŸ‘€ Tell us about your idea" - type: textarea attributes: label: Feature request - description: A description of the feature you would like. + description: A clear and concise description of the feature you would like. + placeholder: | + When using this project, I would love to be able to... validations: required: true - type: textarea - attributes: - label: Why? + label: Motivations description: | Describe the problem you’re tackling with this feature request. placeholder: | - + How did you come across this idea? validations: required: true @@ -35,11 +31,9 @@ body: description: | Have you considered alternative solutions? Is there a workaround? placeholder: | - + Are there workarounds? - type: textarea attributes: @@ -50,7 +44,14 @@ body: - type: markdown attributes: value: | - #### Seeking priority support? - Escalate this issue by becoming a [sponsor](https://github.com/sponsors/privatenumber)! As a sponsor, your concern will receive prompt attention, ensuring faster and more efficient resolution. + > **πŸ™‹ Experiencing a challenging problem and need expert assistance?** + > + > Get personalized help through my [_Priority Support_ service](https://github.com/sponsors/privatenumber). From debugging to implementation, I'm here to assist you! + + - type: markdown + attributes: + value: | + ## πŸš€ Need immediate attention? + Escalate this issue by becoming a [_Priority Patron_ sponsor](https://github.com/sponsors/privatenumber)! As a _Priority Patron_, your concern will receive prompt attention, ensuring faster and more efficient resolution. - [πŸ‘‰ Get priority support now!](https://github.com/sponsors/privatenumber) + [πŸ‘‰ Become a _Priority Patron_ now!](https://github.com/sponsors/privatenumber) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5dc666e..e68164a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,9 +1,9 @@ blank_issues_enabled: false contact_links: - - name: Help / Questions / Discussions + - name: πŸ’¬ Help / Questions / Discussions url: https://github.com/esbuild-kit/esbuild-loader/discussions about: Use GitHub Discussions for anything else - - name: Priority support ⭐️ + - name: πŸš€ Priority Support url: https://github.com/sponsors/privatenumber/ - about: Join our community of sponsors and enjoy priority attention for all your questions and concerns + about: Need help? Get prioritized help for all your questions and issues