From 7a0d3386781474f63f849d92454bca094a5b2f06 Mon Sep 17 00:00:00 2001 From: Stijn Van Hulle Date: Mon, 23 Oct 2023 23:18:34 +0200 Subject: [PATCH] chore: update issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 25 +++++++++++++++++++++++-- .github/ISSUE_TEMPLATE/feature.yml | 7 ++++--- .github/ISSUE_TEMPLATE/install.yml | 3 +-- codecov.yml | 2 +- 4 files changed, 29 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 3948f1bf5..c67cdab57 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -16,12 +16,33 @@ body: attributes: label: What platform is your computer? description: MacOS, Windows, Linux. + - type: input + attributes: + label: What version of external packages are you using(`@tanstack-query`, `MSW`, `React`, `Vue`, ...) + description: Copy the output of your `package.json` - type: textarea attributes: label: What steps can reproduce the bug? - description: Explain the bug and provide a code snippet that can reproduce it. + description: | + Explain the bug and provide a code snippet that can reproduce it. + Please add a link to a minimal reproduction. + Note: + - Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React/Solid/Vue/Svelte. + - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/). + - For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play + - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve validations: required: true + - type: dropdown + attributes: + label: How often does this bug happen? + description: | + Following the repro steps above, how easily are you able to reproduce this bug? + options: + - Every time + - Often + - Sometimes + - Only once - type: textarea attributes: label: What is the expected behavior? @@ -33,4 +54,4 @@ body: - type: textarea attributes: label: Additional information - description: Is there anything else you think we should know? \ No newline at end of file + description: Is there anything else you think we should know? diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 11e43400d..1e0d41b26 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -13,11 +13,12 @@ body: label: What is the problem this feature would solve? validations: required: true + - type: textarea + attributes: + label: External documents/projects? - type: textarea attributes: label: What is the feature you are proposing to solve the problem? - validations: - required: true - type: textarea attributes: - label: What alternatives have you considered? \ No newline at end of file + label: What alternatives have you considered? diff --git a/.github/ISSUE_TEMPLATE/install.yml b/.github/ISSUE_TEMPLATE/install.yml index fba10bf83..72a357a3e 100644 --- a/.github/ISSUE_TEMPLATE/install.yml +++ b/.github/ISSUE_TEMPLATE/install.yml @@ -8,7 +8,6 @@ body: attributes: value: | Thank you for submitting a bug report. It helps make `Kubb` better. - - type: input attributes: label: What platform is your computer? @@ -28,4 +27,4 @@ body: - type: textarea attributes: label: Additional information - description: Is there anything else you think we should know? \ No newline at end of file + description: Is there anything else you think we should know? diff --git a/codecov.yml b/codecov.yml index 87a949111..c1c992eee 100644 --- a/codecov.yml +++ b/codecov.yml @@ -3,4 +3,4 @@ coverage: project: default: target: 85% - threshold: 1% + threshold: 5%