Git commit message convention
Every commit made directly to the master branch must follow the below convention. Based on commits in the master branch CKEditor 5 release tools will generate changelog entries for the current release.
Commits in the ticket branches are not analyzed for the changelog and do not have to follow any specific convention (other than finishing sentences with periods). In case of ticket branches, only merge commits are analyzed.
Therefore, this guide is mainly targeted at core team members. However, it may help you understand how to write a suggested commit message when creating a pull request for CKEditor 5.
# Convention
Commit message template:
Type: A short sentence about the commit. Closes #XXX.
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.
# Commit types
| Type | Release | Description | Changelog |
|---|---|---|---|
| Feature | minor |
A new feature. | Visible |
| Fix | patch |
A bug fix. Should also be used for enhancements if they do not introduce new features at the same time. | Visible |
| Other | patch |
An enhancement — when it is neither a bug fix nor a feature. Example: public API refactoring. Use it also if you do not want to admit that it was a bug 😉. | Visible |
| Code style | patch |
Our beloved code style improvements (used in the broad meaning of general code quality). | Hidden |
| Docs | patch |
Updated documentation. | Hidden |
| Internal | patch |
Other kinds of internal changes. | Hidden |
| Tests | patch |
Changes in test files. | Hidden |
| Revert | patch |
Revert of some commit. | Hidden |
| Release | patch |
A special type of commit used by the release tools. | Hidden |
Each commit can contain additional notes which will be inserted into the changelog:
| Type | Is backward compatible? |
|---|---|
NOTE |
Yes |
BREAKING CHANGES or BREAKING CHANGE |
No |
If any visible change contains the BREAKING CHANGE note, the next release will be marked as major automatically.
# Example commits
A new feature without any breaking changes.
Feature: Added support for RTL languages. Closes #1.
RTL content will now be rendered correctly.
NOTE: Make sure to set `config.contentDirection` correctly.
A bug fix for an existing feature (closes two tickets):
Fix: The editor will be great again. Closes #3. Closes #4.
Commit with updated documentation:
Docs: Updated the README.
Commit which provides or changes the tests:
Tests: Introduced missing tests. Closes #5.
An enhancement which is not backward compatible. Public API was changed:
Other: Extracted `utils.moo()` to a separate package. Closes #9.
BREAKING CHANGE: The `util.moo()` method is now available in the `moo` package. See #9.
For the commits shown above the changelog will look like this:
Changelog
=========
## [1.0.0](https://github.com/ckeditor/ckeditor5-dev/compare/v1.0.0...v0.0.1) (2017-01-04)
### Bug fixes
* The editor will be great again. Closes [#3](https://github.com/ckeditor/ckeditor5-dev/issue/3). Closes [#4](https://github.com/ckeditor/ckeditor5-dev/issue/4). ([a0b4ce8](https://github.com/ckeditor/ckeditor5-dev/commit/a0b4ce8))
### Other changes
* Extracted `utils.moo()` to a separate package. Thanks to [@CKEditor](https://github.com/CKEditor). ([e8cc04f](https://github.com/ckeditor/ckeditor5-dev/commit/e8cc04f))
### Features
* Added support for RTL languages. Closes [#1](https://github.com/ckeditor/ckeditor5-dev/issue/1). ([adc59ed](https://github.com/ckeditor/ckeditor5-dev/commit/adc59ed))
RTL content will now be rendered correctly.
### BREAKING CHANGES
* The `util.moo()` method is now available in the `moo` package. See [#9](https://github.com/ckeditor/ckeditor5-dev/issue/9).
### NOTE
* Make sure to set `config.contentDirection` correctly.
# Handling pull requests
When making a pull request its author may (it is recommended in the pull request template) propose a merge commit message.
The reviewer’s duty is to validate the proposed message and apply necessary changes (the PR description can be edited).
Things like:
- language and grammar of the message,
- type of the change,
- mentioned issue(s) number,
- breaking changes,
- and any additional information
should be checked and added if missing.
As a reviewer, remember that the message will end up in the changelog and must be understandable in a broad context of the entire editor. It is not for you — it is for other developers.
When closing a PR remember to copy the source of the message to the textarea with the merge commit message:
# Giving credit
When closing a non-core contributor’s PR make sure to add information about the contributor to the commit message. For example:
Feature: Added support for RTL languages. Closes #1.
Thanks to @someone!