diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c2300f63..7c451ff7 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,13 +1,43 @@ -Thanks for filing an issue! +Thanks for filing an issue! -If at all possible, please provide a Codepen to demonstrate the problem you're having with React Quill. Here's a [template] to get you started. +If at all possible, please provide a Codesandbox or Codepen to demonstrate the problem you're having with React Quill. Here's a [template] to get you started. + +⚠️ Make sure that your bug hasn't already been fixed by ReactQuill `v2.0.0-beta.2`. See the homepage for instructions on how to upgrade. + +[template]: +https://codesandbox.io/s/react-quill-template-u9c9c + + +### Ticket due diligence + +- [ ] I have verified that the issue persists under ReactQuill `v2.0.0-beta.2` +- [ ] I can't use the beta version for other reasons + + +### ReactQuill version + +- [ ] master +- [ ] v2.0.0-beta.2 +- [ ] v2.0.0-beta.1 +- [ ] 1.3.5 +- [ ] 1.3.4 or older +- [ ] Other (fork) -[template]: -https://codepen.io/pen?template=xgyOXQ ### FAQ +**Is this a bug in Quill or ReactQuill?** + +ReactQuill is just a ~thin~ wrapper on top of the Quill editor. Often, what looks like a bug in ReactQuill, is actually a bug in the Quill editor itself. Before opening a ticket, please check the [Quill documentation], and the [issues page], and see if that answers your question first. + +[Quill documentation]: +https://quilljs.com/docs + +[issues page]: +https://github.com/quilljs/quill/issues + **How do I access the wrapped Quill instance?** + See the [instance methods] and [API] documentation. [instance methods]: @@ -15,24 +45,3 @@ https://github.com/zenoamaro/react-quill#methods [API]: https://github.com/zenoamaro/react-quill#api-reference - -**Is there a bug in Quill?** -Please refer to the [Quill issues page]. - -[Quill issues page]: -https://github.com/quilljs/quill/issues - -#### React-Quill version -- [ ] master -- [ ] 0.4.1 -- [ ] 1.0.0-beta-1 -- [ ] 1.0.0-beta-2 -- [ ] 1.0.0-beta-3 -- [ ] 1.0.0-beta-4 -- [ ] 1.0.0-beta-5 -- [ ] 1.0.0-rc-1 -- [ ] 1.0.0-rc-2 -- [ ] 1.0.0-rc-3 -- [ ] 1.0.0 -- [ ] 1.1.0 -- [ ] Other (fork)