improve the issue template, add a documentation feedback template

This commit is contained in:
Hans Pagel 2020-11-11 15:09:11 +01:00
parent 7dd9ca54c8
commit b445f45333
2 changed files with 26 additions and 6 deletions

View File

@ -7,10 +7,10 @@ labels: bug
assignees: ''
---
**Describe the bug**
**What happens?**
A clear and concise description of what the bug is.
**Steps to Reproduce / Codesandbox Example**
**How can others reproduce the issue?**
Steps to reproduce the behavior:
1. Go to …
2. Type in …
@ -20,16 +20,16 @@ Steps to reproduce the behavior:
Create a new Codesandbox replicating your error
https://codesandbox.io/s/vue-issue-template-h0g28
**Expected behavior**
**What behavior did you expect?**
A clear and concise description of what you expected to happen.
**Screenshots**
**Do you have a screenshot?**
If applicable, add screenshots to help explain your problem.
**Environment**
**Whats your environment?**
- Operating system
- Browser
- Mobile/desktop
**Additional context**
**What else?**
Add any other context about the problem here.

20
.github/ISSUE_TEMPLATE/feedback.md vendored Normal file
View File

@ -0,0 +1,20 @@
---
name: Feedback on the documentation
about: How can we improve the documentation?
url: https://github.com/ueberdosis/tiptap-next/issues/new
title: ''
labels: documentation
assignees: ''
---
**Which part of the documentation have you read?**
Ive been to the following page of the documentation …
**Did you find the content helpful?**
I think this part is really good: …
**What was hard to understand, missing or misleading?**
But you really need to improve …
**What else?**
Add any other context here.