Skip to content

Commit

Permalink
Update Github issue templates (drizzle-team#3157)
Browse files Browse the repository at this point in the history
* Update GH issue templates

* Update issue templates

---------

Co-authored-by: Andrii Sherman <[email protected]>
  • Loading branch information
L-Mario564 and AndriiSherman authored Nov 4, 2024
1 parent 0303acc commit 181d181
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 17 deletions.
44 changes: 30 additions & 14 deletions .github/ISSUE_TEMPLATE/bug-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,52 @@ body:
- type: markdown
attributes:
value: |
## Quick Bug Form
Thank you for taking the time to file a bug report! Please fill out this form as completely as possible.
Thank you for taking the time to file a bug report! Please provide as much information as possible.
- type: checkbox
attributes:
label: I have verified that the bug I'm about to report hasn't been filed before.
validations:
required: true

- type: input
attributes:
label: What version of `drizzle-orm` are you using?
description: You can check the version by opening the `package.json` file in your project.
placeholder: 0.0.0
validations:
required: true

- type: input
attributes:
label: What version of `drizzle-kit` are you using?
description: You can check the version by opening the `package.json` file in your project.
placeholder: 0.0.0
validations:
required: false
- type: textarea
attributes:
label: Describe the Bug
description: Steps to reproduce
validations:
required: true
- type: textarea

- type: input
attributes:
label: Expected behavior
description: What you expect to happen
label: Other packages
description: If this bug is related to one of the other first-party packages we maintain, please list them here alongside their version.
placeholder: [email protected], [email protected]
validations:
required: false

- type: textarea
attributes:
label: Environment & setup
description: In which environment does the problem occur?
label: Describe the Bug
description: |
To fill this field, please answer the following:
- What is the undesired behavior?
- What are the steps to reproduce it?
- What is the desired result?
If the issue is more specific, consider answering the following questions if you think they may be relevant:
- What database engine are you using? Are you using a specific cloud provider? Which one?
- Do you think this bug pertains to a specific database driver? Which one?
- Are you working in a monorepo?
- If this is a bug related to types: What Typescript version are you using? What's the content of your tsconfig.json file?
- If you're using a runtime that isn't Node.js: Which one? What version? Have you verified that this isn't an issue with the runtime itself?
validations:
required: false
required: true
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-template.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: "Documentation Enhancement"
description: Suggest documentation improvements
title: "[DOCS]:"
labels: ["docs"]

body:
- type: checkbox
attributes:
label: I have verified this enhancement I'm about to request hasn't been suggested before.
validations:
required: true

- type: textarea
attributes:
label: Describe the enhancement you want to request
description: What do you want to change or add to the documentation?
validations:
required: true
12 changes: 9 additions & 3 deletions .github/ISSUE_TEMPLATE/feature-template.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
name: "Feature Request"
description: Suggest new feature for Drizzle
description: Suggest new feature
title: "[FEATURE]:"
labels: ["enhancement"]

body:
- type: checkbox
attributes:
label: I have verified this feature I'm about to request hasn't been suggested before.
validations:
required: true

- type: textarea
attributes:
label: Describe what you want
description: What is the problem? What do you want to change or add?
label: Describe the enhancement you want to request
description: What do you want to change or add? What are the benefits of implementing this?
validations:
required: true

0 comments on commit 181d181

Please sign in to comment.