diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a9d97d01..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -url: https://github.com/ueberdosis/tiptap/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/tiptap-issue-template-b83rr?file=/src/components/Tiptap.vue (Vue) -https://codesandbox.io/s/tiptap-react-08yxr (React) - -**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/bug_report_default.md b/.github/ISSUE_TEMPLATE/bug_report_default.md new file mode 100644 index 00000000..29fe13bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_default.md @@ -0,0 +1,41 @@ +--- +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 + - v2 +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. diff --git a/.github/ISSUE_TEMPLATE/bug_report_v1.md b/.github/ISSUE_TEMPLATE/bug_report_v1.md new file mode 100644 index 00000000..d58bef99 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_v1.md @@ -0,0 +1,40 @@ +--- +name: Bug report (tiptap v1) +about: Create a report to help us improve tiptap +url: https://github.com/ueberdosis/tiptap/issues/new +title: '' +labels: + - bug + - v1 +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: + +https://codesandbox.io/s/vue-issue-template-h0g28 + +**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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 976c71c3..3d7fed0b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false contact_links: - # - name: Ask a question - # url: https://github.com/ueberdosis/tiptap/discussions/new - # about: Ask the community for help + - name: Discuss tiptap on GitHub + url: https://github.com/ueberdosis/tiptap/discussions/new + about: Help, discussion about best practices, or any other conversation that would benefit from being searchable + - name: Join the tiptap Discord server + url: https://discord.gg/WtJ49jGshW + about: Ccasual chit-chat with others using tiptap diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ce006cb1..821226c8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,19 +1,21 @@ --- name: Feature request -about: Suggest a new feature for tiptap +about: Suggest a new feature for tiptap v2 title: '' -labels: feature request +labels: + - feature request + - v2 assignees: '' --- -**Is your feature request related to a problem? Please describe.** +**The problem I am facing** A clear and concise description of what the problem is. For example: I’m always frustrated when … -**Describe the solution you’d like** +**The solution I would 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. +**Alternatives I have considered** +A clear and concise description of any alternative solutions or features you have considered. **Additional context** -Add any other context or screenshots about the feature request here. +Add any other context or screenshots here. diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md index db748d93..6c10e389 100644 --- a/.github/ISSUE_TEMPLATE/feedback.md +++ b/.github/ISSUE_TEMPLATE/feedback.md @@ -3,18 +3,21 @@ name: Feedback on the documentation about: Share what we need to explain better url: https://github.com/ueberdosis/tiptap/issues/new title: '' -labels: documentation -assignees: '' +labels: + - documentation + - v2 +assignees: + - hanspagel --- -**Which part of the documentation have you read?** -I’ve been to the following page of the documentation … +**Part of the documentation?** +I’ve read the following page of the documentation … -**Did you find the content helpful?** +**Really helpful parts** I think this part is really good: … -**What was hard to understand, missing or misleading?** +**Hard to understand, missing or misleading** But you really need to improve … -**What else?** -Add any other context here. +**Additional context** +Add any other context or screenshots here. diff --git a/docs/src/pages/index.vue b/docs/src/pages/index.vue index ed32e3ce..f2dd93ae 100644 --- a/docs/src/pages/index.vue +++ b/docs/src/pages/index.vue @@ -174,7 +174,7 @@