diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 62785029bc..04db3e7ed5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,8 +5,7 @@ The best way to contribute is to help others in the Quill community. This includ - Reporting new [bugs](https://github.com/quilljs/quill/labels/bug) or adding details to existing ones - Reproducing [unconfirmed bugs](https://github.com/quilljs/quill/labels/needs%20reproduction) - Quick typo fix or documentation improvement [Pull Requests](#pull-requests) -- Participating in [discussions](https://github.com/quilljs/quill/labels/discussion) -- Answering questions on [StackOverflow](http://stackoverflow.com/questions/tagged/quill) +- Participating in [discussions](https://github.com/quilljs/quill/discussions) After becoming familiar with Quill and the codebase, likely through using Quill yourself and making some of the above contributions, you may choose to take on a bigger commitment by: @@ -15,9 +14,12 @@ After becoming familiar with Quill and the codebase, likely through using Quill - Publishing guides, tutorials, and examples - Supporting Quill in other ecosystems (Angular, React, etc) +Note that if you are going to be making significant contributions, you should first open +a [discussion](https://github.com/quilljs/quill/discussions) to ensure your work aligns with the project's goals and direction. + ## Questions -If you have a question, it is best to ask on StackOverflow and tag with [quill](http://stackoverflow.com/questions/tagged/quill). This tag is monitored by Quill maintainers and community members. +If you have a question, it is best to ask on [Discussions](https://github.com/quilljs/quill/discussions) under the Q&A category. ## Bug Reports diff --git a/CHANGELOG.md b/CHANGELOG.md index d1bbf5477e..7ad2b09df6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,36 @@ # 2.0.0 +We are thrilled to announce the release of Quill 2.0! Please check out the [announcement post](https://slab.com/blog/announcing-quill-2-0/). + +### Major Improvements + +- Quill is now a valid ESM package for better ecosystem (e.g. bundlers) and tree-shaking support +- Nested Quill support [#3590](https://github.com/quilljs/quill/pull/3590) +- Improved IME and spell corrector support [#3807](https://github.com/quilljs/quill/pull/3807) +- Semantic cleanups for TEXT_CHANGE event [#3778](https://github.com/quilljs/quill/pull/3778) +- **History**: Record selection in history module [#3823](https://github.com/quilljs/quill/pull/3823) +- Auto detect scrolling container [#3840](https://github.com/quilljs/quill/pull/3840) +- **Clipboard**: Improve support for pasting from Google Docs and Microsoft Word + +### Performance Improvements + +Quill 2.0 includes many performance optimizations, the most important of which is the improved rendering speed for large content. + +- Improve inserting performance [#3815](https://github.com/quilljs/quill/pull/3815) +- Avoid fetching selections when possible [#3538](https://github.com/quilljs/quill/pull/3538) +- No need to setContents when container is empty [#3539](https://github.com/quilljs/quill/pull/3539) + +### Code Modernization + +- Migrated to TypeScript +- Provided official TypeScript declarations +- Migrated to Vitest for unit testing +- Migrated to Playwright for E2E testing +- Migrated website to Gatsby + +For all commits, please see the [2.0.0 release page](https://github.com/quilljs/quill/releases/tag/v2.0.0). + # 2.0.0-rc.5 - **Clipboard** Add support for Quill v1 list attributes