From beeddbb7e651ac38a1129cd30f0b0f227c4c4560 Mon Sep 17 00:00:00 2001 From: uzlopak Date: Wed, 11 May 2022 17:06:38 +0200 Subject: [PATCH 1/4] improve issue templates --- .github/ISSUE_TEMPLATE.md | 20 ------ .github/ISSUE_TEMPLATE/bug.yml | 86 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature.yml | 37 +++++++++++ .github/ISSUE_TEMPLATE/help.yml | 62 +++++++++++++++++++ .github/ISSUE_TEMPLATE/other.yml | 22 +++++++ .github/ISSUE_TEMPLATE/performance.yml | 81 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/regression.yml | 80 ++++++++++++++++++++++++ 8 files changed, 373 insertions(+), 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/ISSUE_TEMPLATE/help.yml create mode 100644 .github/ISSUE_TEMPLATE/other.yml create mode 100644 .github/ISSUE_TEMPLATE/performance.yml create mode 100644 .github/ISSUE_TEMPLATE/regression.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 29d4c02465..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - -**Do you want to request a *feature* or report a *bug*?** - -**What is the current behavior?** - -**If the current behavior is a bug, please provide the steps to reproduce.** - - - - -**What is the expected behavior?** - -**What are the versions of Node.js, Mongoose and MongoDB you are using? Note that "latest" is not a version.** - - diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..6e0a71371f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,86 @@ +name: 🪲 Bug report +description: Create a report to help us improve + +body: + + - type: markdown + attributes: + value: | + Before you submit an issue we recommend to read the [documentation](https://mongoosejs.com/docs/guide.html). + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + - label: | + I have searched existing issues to ensure the bug has not already been reported + required: true + + - type: input + id: mongoose-version + attributes: + label: Mongoose version + placeholder: 6.x.x + validations: + required: true + + - type: input + id: node-version + attributes: + label: Node.js version + placeholder: 14.x + validations: + required: true + + - type: input + id: mongo-version + attributes: + label: MongoDB version + placeholder: 5.x + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating system + options: + - Linux + - macOS + - Windows + validations: + required: false + + - type: input + id: os-version + attributes: + label: Operating system version (i.e. 20.04, 11.3, 10) + validations: + required: false + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: | + List of steps, sample code, or a link to code or a project that reproduces the behavior. + Make sure you place a stack trace inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..11a4b80ddb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +documentation: + - name: 📘 Documentation + url: https://mongoosejs.com/docs/guide.html + about: The manual of mongoose diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000000..b2ace34d02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,37 @@ +name: 🚀 Feature Proposal +description: Submit a proposal for a new feature +labels: ['enhancement', 'new feature'] + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + - label: | + I have searched existing issues to ensure the feature has not already been requested + required: true + + - type: textarea + id: proposal + attributes: + label: 🚀 Feature Proposal + description: A clear and concise description of what the feature is. + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: The motivation for the proposal. + + - type: textarea + id: example + attributes: + label: Example + description: | + An example for how this feature would be used. + Make sure you place example code inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/help.yml b/.github/ISSUE_TEMPLATE/help.yml new file mode 100644 index 0000000000..889adbf090 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help.yml @@ -0,0 +1,62 @@ +name: 🙋 Help +description: Open an issue and request for individual help +labels: ['help', 'help wanted'] + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + + - type: input + id: mongoose-version + attributes: + label: Mongoose version + placeholder: 6.x.x + validations: + required: true + + - type: input + id: node-version + attributes: + label: Node.js version + placeholder: 14.x + validations: + required: true + + - type: input + id: mongo-version + attributes: + label: MongoDB version + placeholder: 5.x + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating system + options: + - Linux + - macOS + - Windows + validations: + required: false + + - type: input + id: os-version + attributes: + label: Operating system version (i.e. 20.04, 11.3, 10) + validations: + required: false + + - type: textarea + id: text + attributes: + label: Issue + description: | + Give as much detail as you can to help us understand. + Make sure you place example code inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 0000000000..5579df501c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,22 @@ +name: ❔ Other +description: Open an issue that is not feature or bug related + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + - label: | + I have searched existing issues to ensure the issue has not already been raised + required: true + + - type: textarea + id: text + attributes: + label: Issue + description: | + Give as much detail as you can to help us understand. + Make sure you place example code inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/performance.yml b/.github/ISSUE_TEMPLATE/performance.yml new file mode 100644 index 0000000000..26cddfd06f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance.yml @@ -0,0 +1,81 @@ +name: 🦥 Performance issue +description: Report a performance issue +labels: ['performance'] + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + - label: | + I have searched existing issues to ensure the regression has not already been reported + required: true + + - type: input + id: working-version + attributes: + label: Last working version + placeholder: 1.x.x + validations: + required: true + + - type: input + id: stopped-working-version + attributes: + label: Stopped working in version + placeholder: 2.x.x + validations: + required: true + + - type: input + id: node-version + attributes: + label: Node.js version + placeholder: 14.x + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating system + options: + - Linux + - macOS + - Windows + validations: + required: false + + - type: input + id: os-version + attributes: + label: Operating system version (i.e. 20.04, 11.3, 10) + validations: + required: false + + - type: textarea + id: description + attributes: + label: 🦥 Performance issue + description: A clear and concise description of what the performance issue is. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: | + List of steps, sample code, or a link to code or a project that reproduces the behavior. + Make sure you place a stack trace inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. diff --git a/.github/ISSUE_TEMPLATE/regression.yml b/.github/ISSUE_TEMPLATE/regression.yml new file mode 100644 index 0000000000..4d51e43b9e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/regression.yml @@ -0,0 +1,80 @@ +name: 💥 Regression Report +description: Report unexpected behavior that worked in previous versions + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + options: + - label: I have written a descriptive issue title + required: true + - label: | + I have searched existing issues to ensure the regression has not already been reported + required: true + + - type: input + id: working-version + attributes: + label: Last working version + placeholder: 1.x.x + validations: + required: true + + - type: input + id: stopped-working-version + attributes: + label: Stopped working in version + placeholder: 2.x.x + validations: + required: true + + - type: input + id: node-version + attributes: + label: Node.js version + placeholder: 14.x + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating system + options: + - Linux + - macOS + - Windows + validations: + required: false + + - type: input + id: os-version + attributes: + label: Operating system version (i.e. 20.04, 11.3, 10) + validations: + required: false + + - type: textarea + id: description + attributes: + label: 💥 Regression Report + description: A clear and concise description of what the regression is. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: | + List of steps, sample code, or a link to code or a project that reproduces the behavior. + Make sure you place a stack trace inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. From d1ffce8dafd253289287aafa9dfb36caa60f1f5a Mon Sep 17 00:00:00 2001 From: uzlopak Date: Wed, 11 May 2022 17:18:50 +0200 Subject: [PATCH 2/4] when requesting help, point to the docs --- .github/ISSUE_TEMPLATE/bug.yml | 6 ------ .github/ISSUE_TEMPLATE/help.yml | 5 +++++ 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 6e0a71371f..52a366c804 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -2,12 +2,6 @@ name: 🪲 Bug report description: Create a report to help us improve body: - - - type: markdown - attributes: - value: | - Before you submit an issue we recommend to read the [documentation](https://mongoosejs.com/docs/guide.html). - - type: checkboxes id: prerequisites attributes: diff --git a/.github/ISSUE_TEMPLATE/help.yml b/.github/ISSUE_TEMPLATE/help.yml index 889adbf090..c9ffe19364 100644 --- a/.github/ISSUE_TEMPLATE/help.yml +++ b/.github/ISSUE_TEMPLATE/help.yml @@ -3,6 +3,11 @@ description: Open an issue and request for individual help labels: ['help', 'help wanted'] body: + - type: markdown + attributes: + value: | + Before you submit an issue we recommend to read the [documentation](https://mongoosejs.com/docs/guide.html). + - type: checkboxes id: prerequisites attributes: From fda32c3b218b0c3ed2a4cc9305d5a5fca8c9914c Mon Sep 17 00:00:00 2001 From: uzlopak Date: Wed, 11 May 2022 17:22:46 +0200 Subject: [PATCH 3/4] refine performance issue --- .github/ISSUE_TEMPLATE/performance.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/performance.yml b/.github/ISSUE_TEMPLATE/performance.yml index 26cddfd06f..5d35d07af3 100644 --- a/.github/ISSUE_TEMPLATE/performance.yml +++ b/.github/ISSUE_TEMPLATE/performance.yml @@ -11,7 +11,7 @@ body: - label: I have written a descriptive issue title required: true - label: | - I have searched existing issues to ensure the regression has not already been reported + I have searched existing issues to ensure the performance issue has not already been reported required: true - type: input From 92cae73a76924658824c98f1efaabcb1de52cefa Mon Sep 17 00:00:00 2001 From: uzlopak Date: Tue, 17 May 2022 07:27:38 +0200 Subject: [PATCH 4/4] adapt changes requested by PR comments --- .github/ISSUE_TEMPLATE/bug.yml | 20 +------ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/performance.yml | 22 +------ .github/ISSUE_TEMPLATE/regression.yml | 80 -------------------------- 4 files changed, 4 insertions(+), 120 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/regression.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 52a366c804..3089b69e90 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -32,29 +32,11 @@ body: - type: input id: mongo-version attributes: - label: MongoDB version + label: MongoDB server version placeholder: 5.x validations: required: true - - type: dropdown - id: os - attributes: - label: Operating system - options: - - Linux - - macOS - - Windows - validations: - required: false - - - type: input - id: os-version - attributes: - label: Operating system version (i.e. 20.04, 11.3, 10) - validations: - required: false - - type: textarea id: description attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 11a4b80ddb..d552e213c6 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,4 @@ blank_issues_enabled: false documentation: - name: 📘 Documentation url: https://mongoosejs.com/docs/guide.html - about: The manual of mongoose + about: Mongoose Docs diff --git a/.github/ISSUE_TEMPLATE/performance.yml b/.github/ISSUE_TEMPLATE/performance.yml index 5d35d07af3..8eef06255b 100644 --- a/.github/ISSUE_TEMPLATE/performance.yml +++ b/.github/ISSUE_TEMPLATE/performance.yml @@ -17,7 +17,7 @@ body: - type: input id: working-version attributes: - label: Last working version + label: Last performant version placeholder: 1.x.x validations: required: true @@ -25,7 +25,7 @@ body: - type: input id: stopped-working-version attributes: - label: Stopped working in version + label: Slowed down in version placeholder: 2.x.x validations: required: true @@ -38,24 +38,6 @@ body: validations: required: true - - type: dropdown - id: os - attributes: - label: Operating system - options: - - Linux - - macOS - - Windows - validations: - required: false - - - type: input - id: os-version - attributes: - label: Operating system version (i.e. 20.04, 11.3, 10) - validations: - required: false - - type: textarea id: description attributes: diff --git a/.github/ISSUE_TEMPLATE/regression.yml b/.github/ISSUE_TEMPLATE/regression.yml deleted file mode 100644 index 4d51e43b9e..0000000000 --- a/.github/ISSUE_TEMPLATE/regression.yml +++ /dev/null @@ -1,80 +0,0 @@ -name: 💥 Regression Report -description: Report unexpected behavior that worked in previous versions - -body: - - type: checkboxes - id: prerequisites - attributes: - label: Prerequisites - options: - - label: I have written a descriptive issue title - required: true - - label: | - I have searched existing issues to ensure the regression has not already been reported - required: true - - - type: input - id: working-version - attributes: - label: Last working version - placeholder: 1.x.x - validations: - required: true - - - type: input - id: stopped-working-version - attributes: - label: Stopped working in version - placeholder: 2.x.x - validations: - required: true - - - type: input - id: node-version - attributes: - label: Node.js version - placeholder: 14.x - validations: - required: true - - - type: dropdown - id: os - attributes: - label: Operating system - options: - - Linux - - macOS - - Windows - validations: - required: false - - - type: input - id: os-version - attributes: - label: Operating system version (i.e. 20.04, 11.3, 10) - validations: - required: false - - - type: textarea - id: description - attributes: - label: 💥 Regression Report - description: A clear and concise description of what the regression is. - validations: - required: true - - - type: textarea - id: steps-to-reproduce - attributes: - label: Steps to Reproduce - description: | - List of steps, sample code, or a link to code or a project that reproduces the behavior. - Make sure you place a stack trace inside a [code (```) block](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) to avoid linking unrelated issues. - validations: - required: true - - - type: textarea - id: expected-behavior - attributes: - label: Expected Behavior - description: A clear and concise description of what you expected to happen.