Skip to content

Commit

Permalink
Add info about extensions to bug report template
Browse files Browse the repository at this point in the history
Since it's common to get questions/"issues" pertaining to this and is
important to help diagnose as well.

e.g. #187,
#174,
#136 (comment)
  • Loading branch information
sjdemartini committed Mar 21, 2024
1 parent 013d839 commit 22f0ccc
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ assignees: ""

A clear and concise description of what the bug is.

Before filing a bug, please confirm that you have:

1. Installed the necessary Tiptap extensions for whatever functionality you are trying to use (e.g. `Color` extension for using the `MenuButtonTextColor`).
2. Passed the extensions you need to the `extensions` field of `RichTextEditor`/`useEditor`

See [README info here](https://github.com/sjdemartini/mui-tiptap#choosing-your-editor-extensions) for more details.

### To Reproduce

Please include a CodeSandbox demo of the problem if possible. (You can fork [this CodeSandbox](https://codesandbox.io/p/sandbox/mui-tiptap-demo-3zl2l6).)
Expand All @@ -28,13 +35,18 @@ A clear and concise description of what you expected to happen.

If applicable, add screenshots to help explain your problem.

### System (please complete the following information):
### System (please complete the following information)

- mui-tiptap version: [e.g. 1.1.0]
- tiptap version: [e.g. 2.0.0]
- Browser: [e.g. Chrome, Firefox]
- Node version: [e.g 16.4.2]
- OS: [e.g. Ubuntu 22.04, macOS 11.4]
- Copy-paste your `extensions` array used for the editor:

```tsx

```

### Additional context

Expand Down

0 comments on commit 22f0ccc

Please sign in to comment.