From df09689eee3654781c23c8ae8ce502a7977dede5 Mon Sep 17 00:00:00 2001 From: Romain Lenzotti Date: Mon, 4 Sep 2023 09:32:13 +0200 Subject: [PATCH] docs: update github issues templates --- .github/ISSUE_TEMPLATE/01_bug-report.md | 35 -------- .github/ISSUE_TEMPLATE/01_bug-report.yml | 88 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02_feature-request.md | 37 -------- .github/ISSUE_TEMPLATE/02_feature-request.yml | 42 +++++++++ 4 files changed, 130 insertions(+), 72 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01_bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/01_bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/02_feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/02_feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/01_bug-report.md b/.github/ISSUE_TEMPLATE/01_bug-report.md deleted file mode 100644 index 7ec088d91bc..00000000000 --- a/.github/ISSUE_TEMPLATE/01_bug-report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us improve -title: "[BUG] Title" -labels: ":bug: bug" -assignees: Romakita ---- - - - -## Information - -- **Version:** 7.x -- Packages: - -A few sentences describing the overall goals of the issue. - -## Example - -```ts -import {} from "@tsed/common"; -``` - -## Acceptance criteria - -- [ ] Criteria 1 diff --git a/.github/ISSUE_TEMPLATE/01_bug-report.yml b/.github/ISSUE_TEMPLATE/01_bug-report.yml new file mode 100644 index 00000000000..39b513201d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug-report.yml @@ -0,0 +1,88 @@ +name: "\U0001F41B Bug report" +description: Create a report to help us improve +title: "[BUG] Title" +labels: [":bug: bug"] +assignees: ["Romakita"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + --- + > **IMPORTANT: Before opening issue** + > + > - Please update all of your packages. I won't investigate on the issue if you are on an old version. + > - Please check that you have the same version for all Ts.ED dependencies (expected the logger). Many issues are related to a misconfigured packages. + > - Please provide a reproducible example (avoid screenshot, prefer copy/pasted code). The stack trace isn't enough to investigate. + > + > If these requirements aren't checked, I WON'T INVESTIGATE (excepted if you are a premium sponsors!) and issue will be closed! + --- + + - type: textarea + id: what-happened + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: To Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Fetch a '...' + 2. Update the '....' + 3. See error + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: code-snippets + attributes: + label: Code snippets + description: If applicable, add code snippets to help explain your problem. + render: TypeScript + validations: + required: false + - type: input + id: repositoryUrl + attributes: + label: Repository URL example + placeholder: https://github.com/your/repository + - type: input + id: os + attributes: + label: OS + placeholder: macOS + validations: + required: true + - type: input + id: language-version + attributes: + label: Node version + placeholder: Node v18.17.1 + validations: + required: true + - type: input + id: lib-version + attributes: + label: Library version + placeholder: v7.34.7 + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02_feature-request.md b/.github/ISSUE_TEMPLATE/02_feature-request.md deleted file mode 100644 index c430240ab03..00000000000 --- a/.github/ISSUE_TEMPLATE/02_feature-request.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Suggest an idea for this project -title: "" -labels: ":sparkles: enhancement" -assignees: Romakita ---- - - - -## Information - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -```ts -import {} from "@tsed/common"; -``` - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -## Acceptance criteria - -- [ ] Criteria 1 diff --git a/.github/ISSUE_TEMPLATE/02_feature-request.yml b/.github/ISSUE_TEMPLATE/02_feature-request.yml new file mode 100644 index 00000000000..10e7024f1bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature-request.yml @@ -0,0 +1,42 @@ +name: "\U0001F680 Feature request" +description: Suggest an idea for this library +labels: [":sparkles: enhancement"] +assignees: ["Romakita"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + + --- + > - All request features / PR are welcome! + > - The Ts.ED team will works on the requested feature if: + > - The community vote massively for it. + > - The you are a premium sponsors (individual or company sponsors). + --- + + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. +# - type: textarea +# id: context +# attributes: +# label: Additional context +# description: Add any other context about the feature request here. +# - type: textarea +# id: context +# attributes: +# label: Acceptance criteria +# description: Add acceptance criteria here.