mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-23 19:19:03 +08:00
New Issue & Discussion Templates (#3907)
* chore: update github templates * chore: add discussion templates
This commit is contained in:
parent
5da7f20428
commit
acbdbf387c
51
.github/DISCUSSION_TEMPLATE/community-extensions.yml
vendored
Normal file
51
.github/DISCUSSION_TEMPLATE/community-extensions.yml
vendored
Normal file
@ -0,0 +1,51 @@
|
||||
title: "Community Extension: "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Hey! Thanks for your time and effort to create a new community extension! Please make sure to fill out the form below.
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please describe how your extension works and what it does.
|
||||
placeholder: "My extension does …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: installation
|
||||
attributes:
|
||||
label: Installation
|
||||
description: Please describe how users can install your extension.
|
||||
placeholder: "npm install …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: usage
|
||||
attributes:
|
||||
label: Usage
|
||||
description: Please describe how users can use your extension in their editor.
|
||||
placeholder: "To use my extension you have to …"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: type
|
||||
attributes:
|
||||
label: Type
|
||||
description: Please select the type of this extension.
|
||||
options:
|
||||
- "Node"
|
||||
- "Mark"
|
||||
- "Prosemirror plugin"
|
||||
- "Package or Kit"
|
||||
- "Other"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: Other
|
||||
description: Feel free to add any other information about your extension.
|
||||
placeholder: "I hope you like …"
|
||||
validations:
|
||||
required: false
|
36
.github/DISCUSSION_TEMPLATE/feature-requests.yml
vendored
Normal file
36
.github/DISCUSSION_TEMPLATE/feature-requests.yml
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
title: "Feature Request: "
|
||||
labels:
|
||||
- "Type: Feature Request"
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for your time to create a new feature request! Please make sure to fill out the form below.
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please describe the feature you would like to see in Tiptap.
|
||||
placeholder: "I wish there was an extension for …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: use-case
|
||||
attributes:
|
||||
label: Use Case
|
||||
description: Please describe the use case for this feature.
|
||||
placeholder: "I want to use this feature for …"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: type
|
||||
attributes:
|
||||
label: Type
|
||||
description: Please select the type of this feature.
|
||||
options:
|
||||
- "New extension"
|
||||
- "New feature"
|
||||
- "New Tiptap API"
|
||||
- "Other"
|
||||
validations:
|
||||
required: true
|
52
.github/DISCUSSION_TEMPLATE/showcase.yml
vendored
Normal file
52
.github/DISCUSSION_TEMPLATE/showcase.yml
vendored
Normal file
@ -0,0 +1,52 @@
|
||||
title: "Community Extension: "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Hey! Thanks for using Tiptap in your project. We hope you had a great experience. Please take a moment to share your project with us. We would love to see what you built with Tiptap.
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please describe what your project is about
|
||||
placeholder: "My project is about …"
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: url
|
||||
attributes:
|
||||
label: URL
|
||||
description: If possible share the URL of your project.
|
||||
placeholder: "https://example.com"
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: about
|
||||
attributes:
|
||||
label: About
|
||||
description: Feel free to talk about how you used Tiptap in your project, what you liked about it, what you didn't like about it, and what you would like to see in the future.
|
||||
placeholder: "If used Tiptap to …"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: type
|
||||
attributes:
|
||||
label: Type
|
||||
description: Please select the type of your project.
|
||||
options:
|
||||
- "Chat Application"
|
||||
- "Commenting Application"
|
||||
- "Content Management System"
|
||||
- "Document Editor"
|
||||
- "Document Editor with Collaboration"
|
||||
- "Other"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: Other
|
||||
description: Feel free to add any other information about your project.
|
||||
placeholder: "I hope you like …"
|
||||
validations:
|
||||
required: false
|
65
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
65
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@ -1,8 +1,30 @@
|
||||
name: Bug report
|
||||
description: Create a report to help us improve tiptap
|
||||
name: 🐛 Bug report
|
||||
title: "[Bug]: "
|
||||
description: You've found a bug within the editor core or one of the extensions? Feel free to create a bug report to help us fixing it.
|
||||
assignees:
|
||||
- bdbch
|
||||
- svenadlung
|
||||
labels:
|
||||
- bug
|
||||
- "Type: Bug"
|
||||
- "Category: Open Source"
|
||||
- "Status: New"
|
||||
body:
|
||||
- type: input
|
||||
id: packages
|
||||
attributes:
|
||||
label: Which packages did you experience the bug in?
|
||||
description: Please list all packages that you are using.
|
||||
placeholder: core, extension-mention, react
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: What Tiptap version are you using?
|
||||
description: Please list the version of all packages that you are using.
|
||||
placeholder: 2.0.0
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
@ -11,31 +33,34 @@ body:
|
||||
placeholder: "I’m always frustrated when …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: environment
|
||||
- type: dropdown
|
||||
id: browser
|
||||
attributes:
|
||||
label: Which browser was this experienced in? Are any special extensions installed?
|
||||
description: Please give us more information about your browser environment so we can reproduce the bug faster.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: How can we reproduce the bug on our side?
|
||||
description: Steps to reproduce the behavior
|
||||
label: What browser are you using?
|
||||
description: Please list the browser that you are using.
|
||||
options:
|
||||
- Chrome
|
||||
- Firefox
|
||||
- Safari
|
||||
- Edge
|
||||
- Other
|
||||
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.
|
||||
### CodeSandbox templates
|
||||
|
||||
* Vue: https://codesandbox.io/s/tiptap-vue-3-issue-template-9bqq0z?file=/src/App.vue
|
||||
* React: https://codesandbox.io/s/tiptap-react-issue-template-nwvwck?file=/src/App.js
|
||||
- type: textarea
|
||||
id: codesandbox
|
||||
* Javascript: https://codesandbox.io/s/tiptap-js-fv1lyo
|
||||
* React: https://codesandbox.io/s/tiptap-react-qidlsv
|
||||
* Vue 2: https://codesandbox.io/s/tiptap-vue-2-25nq3g
|
||||
* Vue 3: https://codesandbox.io/p/sandbox/tiptap-vue-3-ci7q9h
|
||||
- type: input
|
||||
id: sandbox
|
||||
attributes:
|
||||
label: Can you provide a CodeSandbox?
|
||||
label: Code example
|
||||
description: "Can you provide a CodeSandbox, Stackblitz, GitHub repository or any other kind of code example? This way, we can reproduce your issue faster."
|
||||
placeholder: https://codesandbox.io/s/tiptap-react-issue-template-nwvwck?file=/src/App.js
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
|
94
.github/ISSUE_TEMPLATE/bug_report_pro.yml
vendored
Normal file
94
.github/ISSUE_TEMPLATE/bug_report_pro.yml
vendored
Normal file
@ -0,0 +1,94 @@
|
||||
name: 🐛 Bug report (Tiptap Pro)
|
||||
title: "[PRO]: "
|
||||
description: You are a Tiptap Pro user and have found a bug with one of the Tiptap Pro functionalities? Feel free to report your issue here
|
||||
assignees:
|
||||
- bdbch
|
||||
- svenadlung
|
||||
labels:
|
||||
- "Type: Bug"
|
||||
- "Category: Pro"
|
||||
- "Status: New"
|
||||
body:
|
||||
- type: input
|
||||
id: packages
|
||||
attributes:
|
||||
label: Which packages did you experience the bug in?
|
||||
description: Please list all packages that you are using.
|
||||
placeholder: core, extension-mention, react
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: What Tiptap version are you using?
|
||||
description: Please list the version of all packages that you are using.
|
||||
placeholder: 2.0.0
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What’s the bug you are facing?
|
||||
description: A clear and concise description of what the bug is.
|
||||
placeholder: "I’m always frustrated when …"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: browser
|
||||
attributes:
|
||||
label: What browser are you using?
|
||||
description: Please list the browser that you are using.
|
||||
options:
|
||||
- Chrome
|
||||
- Firefox
|
||||
- Safari
|
||||
- Edge
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### CodeSandbox templates
|
||||
|
||||
* Javascript: https://codesandbox.io/s/tiptap-js-fv1lyo
|
||||
* React: https://codesandbox.io/s/tiptap-react-qidlsv
|
||||
* Vue 2: https://codesandbox.io/s/tiptap-vue-2-25nq3g
|
||||
* Vue 3: https://codesandbox.io/p/sandbox/tiptap-vue-3-ci7q9h
|
||||
- type: input
|
||||
id: sandbox
|
||||
attributes:
|
||||
label: Code example
|
||||
description: "Can you provide a CodeSandbox, Stackblitz, GitHub repository or any other kind of code example? This way, we can reproduce your issue faster."
|
||||
placeholder: https://codesandbox.io/s/tiptap-react-issue-template-nwvwck?file=/src/App.js
|
||||
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: 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: "Use `npm update` to update your dependencies."
|
||||
options:
|
||||
- label: Yes, I’ve updated my dependencies to use the latest version of all packages.
|
||||
required: true
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Are you sponsoring us?
|
||||
options:
|
||||
- label: Yes, I’m a sponsor. 💖
|
||||
required: false
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to send us feedback!
|
19
.github/ISSUE_TEMPLATE/config.yml
vendored
19
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,8 +1,17 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- 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
|
||||
- name: New Feature Request
|
||||
url: https://github.com/ueberdosis/tiptap/discussions/new?category=feature-requests
|
||||
about: You want to create a new feature request for Tiptap? Feel free to do so here.
|
||||
- name: Help & Support
|
||||
url: https://github.com/ueberdosis/tiptap/discussions/new?category=questions-help
|
||||
about: You need help with Tiptap or have a question? Feel free to ask here.
|
||||
- name: Join our Discord
|
||||
url: https://discord.gg/WtJ49jGshW
|
||||
about: Ccasual chit-chat with others using tiptap
|
||||
about: You want to chat with other Tiptap users? Feel free to join our Discord server.
|
||||
- name: Present your project
|
||||
url: https://github.com/ueberdosis/tiptap/discussions/new?category=showcase
|
||||
about: You built something awesome with Tiptap? Feel free to show it off here.
|
||||
- name: Present your Tiptap extensions
|
||||
url: https://github.com/ueberdosis/tiptap/discussions/new?category=community-extensions
|
||||
about: You built a Tiptap extension? Feel free to show it off here.
|
||||
|
@ -1,9 +1,13 @@
|
||||
name: Feedback on the documentation
|
||||
name: Documentation feedback
|
||||
description: Share what we need to explain better
|
||||
title: "[Documentation]: "
|
||||
labels:
|
||||
- documentation
|
||||
- "Type: Documentation"
|
||||
- "Category: Open Source"
|
||||
- "Status: New"
|
||||
assignees:
|
||||
- bdbch
|
||||
- svenadlung
|
||||
body:
|
||||
- type: input
|
||||
id: url
|
44
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
44
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@ -1,44 +0,0 @@
|
||||
name: Feature request
|
||||
description: Suggest a new feature for tiptap
|
||||
labels:
|
||||
- feature request
|
||||
body:
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem are you facing?
|
||||
description: A clear and concise description of what the problem is.
|
||||
placeholder: "I’m always frustrated when …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: What’s the solution you would like to see?
|
||||
description: A clear and concise description of what you want to happen.
|
||||
placeholder: "I’d like …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: What alternatives did you consider?
|
||||
description: A clear and concise description of what you want to happen.
|
||||
placeholder: "I’ve considered to …"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Anything to add? (optional)
|
||||
description: "Add any other context or screenshots here."
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Are you sponsoring us?
|
||||
options:
|
||||
- label: Yes, I’m a sponsor. 💖
|
||||
required: false
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to send us feedback!
|
4
.github/workflows/stale.yml
vendored
4
.github/workflows/stale.yml
vendored
@ -14,5 +14,5 @@ jobs:
|
||||
days-before-stale: 90
|
||||
days-before-close: 7
|
||||
days-before-pr-stale: 180
|
||||
stale-issue-label: stale
|
||||
stale-pr-label: stale
|
||||
stale-issue-label: "Status: Stale"
|
||||
stale-pr-label: "Status: Stale"
|
||||
|
Loading…
Reference in New Issue
Block a user