From 023b740587d623a832a94b793c0753e311d6c108 Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Sat, 20 Jul 2024 00:54:44 +0530 Subject: [PATCH] chore: add issue templates (#614) * chore: add issue templates * Update .github/ISSUE_TEMPLATE/docs.yml Co-authored-by: Nicholas C. Zakas --------- Co-authored-by: Nicholas C. Zakas --- .github/ISSUE_TEMPLATE/bug-report.yml | 57 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/change.yml | 36 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/docs.yml | 36 +++++++++++++++++ 4 files changed, 134 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/change.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..a7e893e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,57 @@ +name: "\U0001F41E Report a problem" +description: "Report a problem with ESLint JS language tools" +title: "Bug: (fill in)" +labels: + - bug + - "repro:needed" +body: + - type: checkboxes + attributes: + label: Which packages are affected? + options: + - label: "`espree`" + required: false + - type: textarea + attributes: + label: Environment + description: | + Please provide the following information: + value: | + Node version: + npm version: + ESLint version: + Operating System: + validations: + required: true + - type: textarea + attributes: + label: What did you do? + validations: + required: true + - type: textarea + attributes: + label: What did you expect to happen? + validations: + required: true + - type: textarea + attributes: + label: What actually happened? + validations: + required: true + - type: input + attributes: + label: Link to Minimal Reproducible Example + description: "Link to a [StackBlitz](https://stackblitz.com) or GitHub repo with a minimal reproduction of the problem. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be auto-closed." + placeholder: "https://stackblitz.com/abcd1234" + validations: + required: true + - type: checkboxes + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this issue. + required: false + - type: textarea + attributes: + label: Additional comments + description: Is there anything else you'd like to mention? diff --git a/.github/ISSUE_TEMPLATE/change.yml b/.github/ISSUE_TEMPLATE/change.yml new file mode 100644 index 00000000..75244e34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/change.yml @@ -0,0 +1,36 @@ +name: "\U0001F680 Request a change" +description: "Request a new feature or change to an existing feature" +title: "Change Request: (fill in)" +labels: + - enhancement +body: + - type: checkboxes + attributes: + label: Which packages would you like to change? + options: + - label: "`espree`" + required: false + - type: textarea + attributes: + label: What problem do you want to solve? + description: | + Please explain your use case in as much detail as possible without referring to a specific solution. + validations: + required: true + - type: textarea + attributes: + label: What do you think is the correct solution? + description: | + Please explain what you'd like to change to address the problem. + validations: + required: true + - type: checkboxes + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this change. + required: false + - type: textarea + attributes: + label: Additional comments + description: Is there anything else you'd like to mention? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..80c6a9c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 🗣 Ask a Question, Discuss + url: https://github.com/eslint/espree/discussions + about: Get help using ESLint diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 00000000..799a862d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,36 @@ +name: "\U0001F4DD Documentation Change" +description: "Request an improvement to documentation" +title: "Docs: (fill in)" +labels: + - documentation +body: + - type: checkboxes + attributes: + label: Which packages would you like to change? + options: + - label: "`espree`" + required: false + - type: textarea + attributes: + label: What documentation issue do you want to solve? + description: | + Please explain your issue in as much detail as possible. + validations: + required: true + - type: textarea + attributes: + label: What do you think is the correct solution? + description: | + Please explain how you'd like to change the ESLint docs to address the problem. + validations: + required: true + - type: checkboxes + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this change. + required: false + - type: textarea + attributes: + label: Additional comments + description: Is there anything else you'd like to mention?