|
|
@@ -18,14 +18,16 @@ Every commit made *directly* to the `master` branch must follow the below conven
|
|
|
Commit message template:
|
|
|
|
|
|
```
|
|
|
-Type (package-name, other-package-name): A short sentence about the commit. Closes #XXX.
|
|
|
+Type (package-name): A short sentence about the commit. Closes #XXX.
|
|
|
+
|
|
|
+Type (other-package-name): If the change affects more than one package, it's possible to put multiple entries at once. Closes #YYY.
|
|
|
|
|
|
Optional description.
|
|
|
|
|
|
NOTE: Special note to be marked in the changelog.
|
|
|
|
|
|
BREAKING CHANGE: If any breaking changes were done, they need to be listed here.
|
|
|
-BREAKING CHANGE: Another breaking change if needed. Closes #YYY.
|
|
|
+BREAKING CHANGE: Another breaking change if needed. Closes #ZZZ.
|
|
|
```
|
|
|
|
|
|
### Commit types
|
|
|
@@ -59,14 +61,14 @@ For reference on how to identify minor or major breaking change see the {@link f
|
|
|
|
|
|
Most commits are related to one or more packages. Each affected package should be listed in parenthesis following the commit type. A package that was the most impacted by the change should be listed first.
|
|
|
|
|
|
-It is, however, possible to skip this part if five or more packages are affected.
|
|
|
+It is, however, possible to skip this part if many packages are affected. This is a typically indication that this is a generic change and listing, all the packages would reduce changelog readability.
|
|
|
|
|
|
### Example commits
|
|
|
|
|
|
A new feature without any breaking changes.
|
|
|
|
|
|
```
|
|
|
-Feature (ui, theme-lark): Added support for RTL languages. Closes #1.
|
|
|
+Feature (ui): Added support for RTL languages. Closes #1.
|
|
|
|
|
|
RTL content will now be rendered correctly.
|
|
|
|
|
|
@@ -91,12 +93,14 @@ Commit which provides or changes the tests:
|
|
|
Tests (widget): Introduced missing tests. Closes #5.
|
|
|
```
|
|
|
|
|
|
-An enhancement which is not backward compatible. Public API was changed:
|
|
|
+An enhancement which is not backward compatible and sent by a non-core contributor. Public API was changed:
|
|
|
|
|
|
```
|
|
|
-Other (utils, moo): Extracted `utils.moo()` to a separate package. Closes #9.
|
|
|
+Other (utils): Extracted the `utils.foo()` to a separate package. Closes #9.
|
|
|
+
|
|
|
+Feature (engine): Introduced the `engine.foo()` method. Closes #9.
|
|
|
|
|
|
-BREAKING CHANGE: The `util.moo()` method is now available in the `moo` package. See #9.
|
|
|
+BREAKING CHANGE: The `utils.foo()` method was moved to the `engine` package. See #9.
|
|
|
```
|
|
|
|
|
|
For the commits shown above the changelog will look like this:
|
|
|
@@ -109,11 +113,12 @@ Changelog
|
|
|
|
|
|
### MAJOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
|
|
|
|
|
|
-* The `util.moo()` method is now available in the `moo` package. See [#9](https://github.com/ckeditor/ckeditor5/issue/9).
|
|
|
+* The `utils.foo()` method was moved to the `engine` package. See #9. See [#9](https://github.com/ckeditor/ckeditor5/issue/9).
|
|
|
|
|
|
### Features
|
|
|
|
|
|
-* [ui](http://npmjs.com/package/@ckeditor/ckeditor5-ui), [theme-lark](http://npmjs.com/package/@ckeditor/ckeditor5-theme-lark): Added support for RTL languages. Closes [#1](https://github.com/ckeditor/ckeditor5/issue/1). ([adc59ed](https://github.com/ckeditor/ckeditor5/commit/adc59ed))
|
|
|
+* [engine](http://npmjs.com/package/@ckeditor/ckeditor5-engine): Introduced the `engine.foo()` method. Thanks to [@CKEditor](https://github.com/CKEditor). Closes [#9](https://github.com/ckeditor/ckeditor5/issue/9). ([e8cc04f](https://github.com/ckeditor/ckeditor5/commit/e8cc04f))
|
|
|
+* [ui](http://npmjs.com/package/@ckeditor/ckeditor5-ui): Added support for RTL languages. Closes [#1](https://github.com/ckeditor/ckeditor5/issue/1). ([adc59ed](https://github.com/ckeditor/ckeditor5/commit/adc59ed))
|
|
|
|
|
|
RTL content will now be rendered correctly.
|
|
|
|
|
|
@@ -123,7 +128,7 @@ Changelog
|
|
|
|
|
|
### Other changes
|
|
|
|
|
|
-* [utils](http://npmjs.com/package/@ckeditor/ckeditor5-utils), [moo](http://npmjs.com/package/@ckeditor/ckeditor5-moo): Extracted `utils.moo()` to a separate package. Thanks to [@CKEditor](https://github.com/CKEditor). ([e8cc04f](https://github.com/ckeditor/ckeditor5/commit/e8cc04f))
|
|
|
+* [utils](http://npmjs.com/package/@ckeditor/ckeditor5-utils): Extracted the `utils.foo()` to a separate package. Thanks to [@CKEditor](https://github.com/CKEditor). ([e8cc04f](https://github.com/ckeditor/ckeditor5/commit/e8cc04f))
|
|
|
|
|
|
### NOTE
|
|
|
|