Use GitHub issue forms

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
This commit is contained in:
Erik Michelson 2021-09-16 23:40:35 +02:00 committed by David Mehren
parent cda17d9d1f
commit 053614e3c8
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
6 changed files with 155 additions and 96 deletions

View file

@ -1,40 +0,0 @@
---
name: Bug report
about: Create a report to help us improve HedgeDoc.
title: ''
labels: 'type: bug'
assignees: ''
---
<!-- 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! -->
**Description**
<!-- A clear and concise description of what the bug is. -->
**To Reproduce**
<!-- Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error -->
**Expected behavior**
<!-- A clear and concise description of what you expected to happen. -->
**Logs**
<!-- If applicable, add an excerpt from the server logs where the error is reported. Remember to censor sensitive values. -->
**Config**
<!-- If applicable, copy and paste your config (or ideally only relevant parts of it) here. Remember to censor sensitive values. -->
**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**
<!-- Add any other context about the problem here. -->

70
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -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

View file

@ -1,29 +0,0 @@
---
name: Enhancement request
about: Suggest an enhancement of an existing feature.
title: ''
labels: 'type: enhancement'
assignees: ''
---
<!-- If you're requesting a new feature, that isn't part of this project yet, then please consider filling out a "feature request" instead! -->
<!-- If you want to report a bug or an error, then please consider filling out a "bug report" instead! -->
**Which part of the project should be enhanced?**
<!-- A clean and concise description of which part should be modified. -->
**Is your enhancement 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 and why.
-->
**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered.
-->
**Additional context**
<!-- Add any other context or screenshots about the feature request here.
-->

View file

@ -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

View file

@ -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: ''
---
<!-- 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! -->
**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.
-->
**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered.
-->
**Additional context**
<!-- Add any other context or screenshots about the feature request here.
-->

View file

@ -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