From ebe7683cb9c988b2887a45a1191ff92f50bb8da5 Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Thu, 16 Sep 2021 23:40:35 +0200 Subject: [PATCH] Use GitHub issue forms Signed-off-by: Erik Michelson --- .github/ISSUE_TEMPLATE/bug_report.md | 40 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 70 +++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement_request.md | 29 -------- .../ISSUE_TEMPLATE/enhancement_request.yml | 46 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 ------- .github/ISSUE_TEMPLATE/feature_request.yml | 39 +++++++++++ 6 files changed, 155 insertions(+), 96 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 1736721bb..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve HedgeDoc. -title: '' -labels: 'type: bug' -assignees: '' - ---- - - - - -**Description** - - -**To Reproduce** - - -**Expected behavior** - - -**Logs** - - -**Config** - - -**Your Setup (please complete the following information):** - - Host OS: [e.g. Ubuntu 20.04] - - NodeJS version [run `node --version`] - - HedgeDoc version (Click "Version info" in the footer) - - server [e.g. 2.0] - - client [e.g. 2.0] - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..487864a45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,70 @@ +name: Bug report +description: Create a report to help us improve HedgeDoc. +title: "" +labels: ["type: bug"] +body: + - type: markdown + attributes: + value: | + - If you're requesting an improvement for an existing feature, then please consider filling out an "enhancement request" instead! + - If you're requesting a new feature, that isn't part of this project yet, then please consider filling out a "feature request" instead! + - type: input + id: description + attributes: + label: Description + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: What did you do to reproduce the behavior? + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs + description: If applicable, add an excerpt from the server logs where the error is reported. Remember to censor sensitive values. + render: shell + validations: + required: false + - type: textarea + id: config + attributes: + label: Config + description: If applicable, copy and paste your config (or ideally only relevant parts of it) here. Remember to censor sensitive values. + render: shell + validations: + required: false + - type: textarea + id: setup + attributes: + label: Your Setup + description: Please complete the following information. + value: | + - Host OS: [e.g. Ubuntu 20.04] + - NodeJS version: [run `node --version`] + - HedgeDoc version: (Click "Releases" in the footer) + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md deleted file mode 100644 index dee13b03c..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement_request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Enhancement request -about: Suggest an enhancement of an existing feature. -title: '' -labels: 'type: enhancement' -assignees: '' - ---- - - - - -**Which part of the project should be enhanced?** - - -**Is your enhancement request related to a problem? Please describe.** - - -**Describe the solution you'd like** - - -**Describe alternatives you've considered** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.yml b/.github/ISSUE_TEMPLATE/enhancement_request.yml new file mode 100644 index 000000000..e729c08a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_request.yml @@ -0,0 +1,46 @@ +name: Enhancement request +description: Suggest an enhancement of an existing feature. +title: "" +labels: ["type: enhancement"] +body: + - type: markdown + attributes: + value: | + - If you want to report a bug or an error, then please consider filling out a "bug report" instead! + - If you're requesting a new feature, that isn't part of this project yet, then please consider filling out a "feature request" instead! + - type: input + id: part + attributes: + label: Which part of the project should be enhanced? + description: A clean and concise description of which part should be modified. + validations: + required: true + - type: textarea + id: problem + attributes: + label: Is your enhancement request related to a problem? Please describe. + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: false + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen and why. + validations: + required: true + - 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. + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context or screenshots about the enhancement request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8a861a4a8..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature request -about: Suggest a new feature for this project, which isn't existing yet. -title: '' -labels: 'type: feature' -assignees: '' - ---- - - - - - -**Is your feature request related to a problem? Please describe.** - - -**Describe the solution you'd like** - - -**Describe alternatives you've considered** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..987c430ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature request +description: Suggest a new feature for this project, which isn't existing yet. +title: "" +labels: ["type: feature"] +body: + - type: markdown + attributes: + value: | + - If you're requesting an improvement for an existing feature, then please consider filling out an "enhancement request" instead! + - If you want to report a bug or an error, then please consider filling out a "bug report" instead! + - 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. + placeholder: I'm always frustrated when [...] + validations: + required: false + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen and why. + validations: + required: true + - 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. + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context or screenshots about the enhancement request here. + validations: + required: false