github: transform the bug report template to an issue form

This commit is contained in:
Hans Pagel 2021-09-29 00:24:46 +02:00
parent d8d76b67bb
commit d5d5e8174b
4 changed files with 71 additions and 42 deletions

69
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,69 @@
name: Bug report
description: Create a report to help us improve tiptap
labels:
- bug
body:
- type: textarea
id: problem
attributes:
label: Whats the bug you are facing?
description: A clear and concise description of what the bug is.
placeholder: "Im always frustrated when …"
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: How can we reproduce the bug on our side?
description: Steps to reproduce the behavior
validations:
required: true
- type: markdown
attributes:
value: |
Chances that we can fix your issue are way higher, if you can provide a CodeSandbox to reproduce the issue.
* Vue: https://codesandbox.io/s/tiptap-issue-template-b83rr?file=/src/components/Tiptap.vue
* React: https://codesandbox.io/s/tiptap-react-08yxr
- type: textarea
id: codesandbox
attributes:
label: Can you provide a CodeSandbox?
validations:
required: false
- type: textarea
id: expectation
attributes:
label: What did you expect to happen?
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: expectation
attributes:
label: What did you expect to happen?
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: context
attributes:
label: Anything to add? (optional)
description: "Add any other context, screenshots, videos or GIFs here."
- type: checkboxes
attributes:
label: Did you update your dependencies?
description: `yarn upgrade-interactive`
options:
- label: Yes, Ive updated my dependencies to use the latest version of all packages.
required: true
- type: checkboxes
attributes:
label: Are you sponsoring us?
options:
- label: Yes, Im a sponsor. 💖
required: false
- type: markdown
attributes:
value: |
Thanks for taking the time to send us feedback!

View File

@ -1,40 +0,0 @@
---
name: Bug report (tiptap v2)
about: Create a report to help us improve tiptap
url: https://github.com/ueberdosis/tiptap/issues/new
title: ''
labels:
- bug
assignees: ''
---
**Description**
A clear and concise description of what the bug is.
**Steps to reproduce the bug**
Steps to reproduce the behavior:
1. Go to …
2. Type in …
3. Click on …
4. See error message
**CodeSandbox**
I created a CodeSandbox to help you debug the issue:
* Vue: https://codesandbox.io/s/tiptap-issue-template-b83rr?file=/src/components/Tiptap.vue
* React: https://codesandbox.io/s/tiptap-react-08yxr
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshot, video, or GIF**
If applicable, add screenshots to help explain your problem.
**Environment?**
- operating system:
- browser:
- mobile/desktop:
- tiptap version:
**Additional context**
Add any other context about the problem here.

View File

@ -31,7 +31,7 @@ body:
id: context
attributes:
label: Anything to add? (optional)
placeholder: "Add any other context or screenshots here."
description: "Add any other context or screenshots here."
- type: checkboxes
attributes:
label: Are you sponsoring us?

View File

@ -37,7 +37,7 @@ body:
id: context
attributes:
label: Anything to add? (optional)
placeholder: "Add any other context or screenshots here."
description: "Add any other context or screenshots here."
- type: markdown
attributes:
value: |