Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved issue templates #11794

Merged
merged 5 commits into from
May 28, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: 🪲 Bug report
description: Create a report to help us improve

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 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
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved
placeholder: 5.x
validations:
required: true

- type: dropdown
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved
id: os
attributes:
label: Operating system
options:
- Linux
- macOS
- Windows
validations:
required: false

- type: input
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved
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.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
documentation:
- name: 📘 Documentation
url: https://mongoosejs.com/docs/guide.html
about: The manual of mongoose
Uzlopak marked this conversation as resolved.
Show resolved Hide resolved
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -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.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/help.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: 🙋 Help
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:
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.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -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.
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.yml
Original file line number Diff line number Diff line change
@@ -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 performance issue 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.
Loading