diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..33bbbde9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve +url: https://github.com/ueberdosis/tiptap-next/issues/new +title: '' +labels: bug +assignees: '' +--- + +**What happens?** +A clear and concise description of what the bug is. + +**How can others reproduce the issue?** +Steps to reproduce the behavior: +1. Go to … +2. Type in … +3. Click on … +4. See error message + +Create a new Codesandbox replicating your error +https://codesandbox.io/s/vue-issue-template-h0g28 + +**What behavior did you expect?** +A clear and concise description of what you expected to happen. + +**Do you have a screenshot?** +If applicable, add screenshots to help explain your problem. + +**What’s your environment?** + - Operating system + - Browser + - Mobile/desktop + +**What else?** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..976c71c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + # - name: Ask a question + # url: https://github.com/ueberdosis/tiptap/discussions/new + # about: Ask the community for help diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..ce006cb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest a new feature for tiptap +title: '' +labels: feature request +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. For example: 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. diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md new file mode 100644 index 00000000..853047a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feedback.md @@ -0,0 +1,20 @@ +--- +name: Feedback on the documentation +about: Share what we need to explain better +url: https://github.com/ueberdosis/tiptap-next/issues/new +title: '' +labels: documentation +assignees: '' +--- + +**Which part of the documentation have you read?** +I’ve 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. diff --git a/README.md b/README.md index 93f4377b..079dff9d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# tiptap 2.x Preview -> Don’t use this in production. It’s full of bugs and the API will likely change. +> Don’t try this at home! Nothing here is production-ready, don’t use it anywhere. -A renderless and extendable rich-text editor for [Vue.js](https://github.com/vuejs/vue) +# tiptap 2 (Preview!) + +A renderless and extendable rich-text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror), which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.