From 3f94365fa7d56a3a8b9b54c0fe14618dc6bf0317 Mon Sep 17 00:00:00 2001 From: Sebastian Beltran Date: Wed, 28 May 2025 22:24:18 -0500 Subject: [PATCH 1/2] feat: add new issue templates for bug reports, feature requests, documentation issues, and questions Signed-off-by: Sebastian Beltran --- .github/ISSUE_TEMPLATE/1-bug_report.yml | 63 +++++++++++++++++++ .github/ISSUE_TEMPLATE/1question.md | 16 ----- .github/ISSUE_TEMPLATE/2-feature_request.yml | 36 +++++++++++ .github/ISSUE_TEMPLATE/2bug_report.md | 41 ------------ .github/ISSUE_TEMPLATE/3-documentation.yml | 38 +++++++++++ .github/ISSUE_TEMPLATE/3feature_request.md | 13 ---- .github/ISSUE_TEMPLATE/4-question.yml | 40 ++++++++++++ .github/ISSUE_TEMPLATE/4documentation.yml | 22 ------- .../ISSUE_TEMPLATE/{5other.md => 5-other.md} | 0 .github/ISSUE_TEMPLATE/config.yml | 5 ++ 10 files changed, 182 insertions(+), 92 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/1question.md create mode 100644 .github/ISSUE_TEMPLATE/2-feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/2bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/3-documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/3feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/4-question.yml delete mode 100644 .github/ISSUE_TEMPLATE/4documentation.yml rename .github/ISSUE_TEMPLATE/{5other.md => 5-other.md} (100%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml new file mode 100644 index 0000000..e912296 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -0,0 +1,63 @@ +name: 🐛 Bug Report +title: '🐛 Bug: ' +about: Do you believe you have found a bug? +labels: + - 'require-triage' +type: Bug + +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug! Please fill out the following sections to help us understand the issue. + + - type: checkboxes + attributes: + description: If any of these required steps are missed, we might not be able to review your issue. + label: Bug Report Checklist + options: + - label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: I have searched for related issues but none matched my issue. + required: true + + - type: input + attributes: + label: Version + description: | + To check the installed version, you can use the following command: `npm ls name-of-package name-of-othe-package` + validations: + required: true + + - type: textarea + attributes: + label: Platform + render: text + description: | + UNIX: output of `uname -a` + Windows: output of `"$([Environment]::OSVersion.VersionString) $(('x86', 'x64')[[Environment]::Is64BitOperatingSystem])"` in PowerShell console + + - type: input + attributes: + label: Node.js version + description: | + Output of `node -v`. + + - type: textarea + attributes: + label: What is the current behavior? + description: | + Please describe the current behavior of the application, including any error messages or unexpected results. + validations: + required: true + + - type: textarea + labels: Minimal, Reproducible Example + attributes: + label: What steps will reproduce the bug? + description: | + Please provide detailed steps to reproduce the problem. + + To help us understand and fix the issue efficiently, please create a [MCVE](https://stackoverflow.com/help/mcve). + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/1question.md b/.github/ISSUE_TEMPLATE/1question.md deleted file mode 100644 index 50b0430..0000000 --- a/.github/ISSUE_TEMPLATE/1question.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Question -about: Seeking help or have a question about usage? -labels: ["question", "require-triage"] ---- - - diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml new file mode 100644 index 0000000..827155b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -0,0 +1,36 @@ +name: 🚀 Feature Request +title: '🚀 feature: ' +about: Do you want to make a feature request? +type: Feature +labels: + - "ideas" + - "require-triage" + +body: + - type: markdown + attributes: + value: | + Thank you for submitting a feature request! Please fill out the following sections to help us understand the request. + - type: checkboxes + attributes: + label: Feature Request Checklist + description: If any of these required steps are missed, we might not be able to review your issue. + options: + - label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: I have searched for related issues but none matched my issue. + required: true + - type: textarea + attributes: + description: What is the feature gap or problem you'd like to address? + label: Overview + validations: + required: true + - type: textarea + attribute: + description: | + label: How should this be implemented in your opinion? + - type: textarea + attributes: + description: Any additional info you'd like to provide. + label: Additional Info diff --git a/.github/ISSUE_TEMPLATE/2bug_report.md b/.github/ISSUE_TEMPLATE/2bug_report.md deleted file mode 100644 index 84df8e9..0000000 --- a/.github/ISSUE_TEMPLATE/2bug_report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: 🐛 Bug Report -about: Do you believe you have found a bug? -labels: ["bug", "require-triage"] -type: Bug ---- - - - -## Environment information - -**Version**: - - -**Platform**: - - -**Node.js version**: - - -**Any other relevant information**: - -## What steps will reproduce the bug? diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 0000000..0d15a1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,38 @@ +name: 📝 Documentation Issue +description: Report a possible issue in the documentation +title: '📝 docs: ' +labels: + - "docs" + - "require-triage" + +body: + - type: markdown + attributes: + value: | + Thank you for submitting this issue! We'll try to triage it ASAP! + + - type: checkboxes + attributes: + label: Documentation Issue Checklist + description: If any of these required steps are missed, we might not be able to review your issue. + options: + - label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: I have searched for related issues but none matched my issue. + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Please provide a description of the issue + validations: + required: true + + - type: textarea + id: expectations + attributes: + label: Expectations + description: Describe the expected behavior + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3feature_request.md b/.github/ISSUE_TEMPLATE/3feature_request.md deleted file mode 100644 index 7460e1a..0000000 --- a/.github/ISSUE_TEMPLATE/3feature_request.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Feature Request -about: Do you want to make a feature request? -labels: ["ideas", "require-triage"] ---- - - diff --git a/.github/ISSUE_TEMPLATE/4-question.yml b/.github/ISSUE_TEMPLATE/4-question.yml new file mode 100644 index 0000000..08e7234 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-question.yml @@ -0,0 +1,40 @@ +name: ❓ Question +about: Seeking help or have a question about usage? +title: '❓ question: ' +labels: + - "question" + - "require-triage" + +body: + - type: markdown + attributes: + value: | + **Thank you for your question!** + To help us better understand and assist you, please fill out the following sections with the relevant details. + + Please note that we can't debug your entire application for you, but we're happy to help answer specific questions. + + You can also connect with the community in the OpenJS Slack workspace: + + * [Join Slack](https://slack-invite.openjsf.org/) + * [#express channel](https://openjs-foundation.slack.com/archives/C02QB1731FH) + + + - type: checkboxes + attributes: + label: Question Checklist + description: If any of these required steps are missed, we might not be able to review your issue. + options: + - label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md) + required: true + - label: I have searched for related issues but none matched my issue. + required: true + + - type: textarea + attributes: + label: Question + description: | + Please provide a clear and concise description of your question or the issue you're facing. + Include any relevant code snippets, error messages, or context that will help us understand your question better. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/4documentation.yml b/.github/ISSUE_TEMPLATE/4documentation.yml deleted file mode 100644 index d7a01fe..0000000 --- a/.github/ISSUE_TEMPLATE/4documentation.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Documentation issue -description: Report a possible issue in the documentation -labels: ["doc", "require-triage"] -body: - - type: markdown - attributes: - value: | - Thank you for submitting this issue! We'll try to triage it ASAP! - - type: textarea - id: description - attributes: - label: Description - description: Please provide a description of the issue - validations: - required: true - - type: textarea - id: expectations - attributes: - label: Expectations - description: Describe the expected behavior - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/5other.md b/.github/ISSUE_TEMPLATE/5-other.md similarity index 100% rename from .github/ISSUE_TEMPLATE/5other.md rename to .github/ISSUE_TEMPLATE/5-other.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a11187c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 🌐 Website issues + url: https://github.com/expressjs/expressjs.com/issues/new/choose + about: For website issues. \ No newline at end of file From 97c0bc8b8e958e2a4baca00cde52a20de8e8074e Mon Sep 17 00:00:00 2001 From: Sebastian Beltran Date: Wed, 28 May 2025 22:53:36 -0500 Subject: [PATCH 2/2] fix templates Signed-off-by: Sebastian Beltran --- .github/ISSUE_TEMPLATE/1-bug_report.yml | 11 ++++------- .github/ISSUE_TEMPLATE/2-feature_request.yml | 6 +++--- .github/ISSUE_TEMPLATE/4-question.yml | 2 +- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml index e912296..5a01fed 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -1,8 +1,7 @@ -name: 🐛 Bug Report -title: '🐛 Bug: ' -about: Do you believe you have found a bug? -labels: - - 'require-triage' +name: 🐞 Bug Report +title: '🐞 Bug: ' +description: Do you believe you have found a bug? +labels: 'require-triage' type: Bug body: @@ -32,7 +31,6 @@ body: - type: textarea attributes: label: Platform - render: text description: | UNIX: output of `uname -a` Windows: output of `"$([Environment]::OSVersion.VersionString) $(('x86', 'x64')[[Environment]::Is64BitOperatingSystem])"` in PowerShell console @@ -52,7 +50,6 @@ body: required: true - type: textarea - labels: Minimal, Reproducible Example attributes: label: What steps will reproduce the bug? description: | diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml index 827155b..e736cc7 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -1,6 +1,6 @@ name: 🚀 Feature Request title: '🚀 feature: ' -about: Do you want to make a feature request? +description: 'Do you want to make a feature request?' type: Feature labels: - "ideas" @@ -27,8 +27,8 @@ body: validations: required: true - type: textarea - attribute: - description: | + attributes: + description: Please describe the feature you would like to see implemented. label: How should this be implemented in your opinion? - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/4-question.yml b/.github/ISSUE_TEMPLATE/4-question.yml index 08e7234..2dc9329 100644 --- a/.github/ISSUE_TEMPLATE/4-question.yml +++ b/.github/ISSUE_TEMPLATE/4-question.yml @@ -1,5 +1,5 @@ name: ❓ Question -about: Seeking help or have a question about usage? +description: Seeking help or have a question about usage? title: '❓ question: ' labels: - "question"