From 181d1819cf7d498b83b1465244fdf43bda3b23e7 Mon Sep 17 00:00:00 2001 From: L-Mario564 Date: Mon, 4 Nov 2024 01:56:06 -0800 Subject: [PATCH] Update Github issue templates (#3157) * Update GH issue templates * Update issue templates --------- Co-authored-by: Andrii Sherman --- .github/ISSUE_TEMPLATE/bug-template.yaml | 44 +++++++++++++------- .github/ISSUE_TEMPLATE/docs-template.yaml | 18 ++++++++ .github/ISSUE_TEMPLATE/feature-template.yaml | 12 ++++-- 3 files changed, 57 insertions(+), 17 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/docs-template.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-template.yaml b/.github/ISSUE_TEMPLATE/bug-template.yaml index 84072af6b..8a0431128 100644 --- a/.github/ISSUE_TEMPLATE/bug-template.yaml +++ b/.github/ISSUE_TEMPLATE/bug-template.yaml @@ -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: drizzle-zod@0.0.0, drizzle-valibot@0.0.0 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 diff --git a/.github/ISSUE_TEMPLATE/docs-template.yaml b/.github/ISSUE_TEMPLATE/docs-template.yaml new file mode 100644 index 000000000..6c2785a15 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-template.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature-template.yaml b/.github/ISSUE_TEMPLATE/feature-template.yaml index 163b179a9..b2c13d671 100644 --- a/.github/ISSUE_TEMPLATE/feature-template.yaml +++ b/.github/ISSUE_TEMPLATE/feature-template.yaml @@ -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