Entries that should be added to the changelog.The proper order of sections for a commit message is as follows: ![]() And example of a properly named method: MarkerCollection#has() No reference – when the PR does not reference any issue.Īll methods mentioned in the git commit message should use the # sign between the class name and the method name.See #123 – when the PR only references an issue, but does not close it yet.Closes #123 (outside the merge message) – when a PR in a public repo closes an issue from a private repository.Closes #123 – when the PR closes an issue.Add these in the same line with the merge message: When creating PRs that address specific issues, use the following messages to indicate it. If the commit introduces a breaking change across the entire project (a generic change), the package name does not have to be specified. If any change contains the MAJOR BREAKING CHANGE note, the next release will automatically be marked as major.įor reference on how to identify minor or major breaking change see the versioning policy guide.Įach MAJOR BREAKING CHANGE or MINOR BREAKING CHANGE note must be followed by the package name. Use it also if you do not want to admit that it was a bug □.Ī special type of commit used by the release tools.Įach commit can contain additional notes that will be inserted into the changelog: Should also be used for enhancements if they do not introduce new features at the same time.Īn enhancement – when it is neither a bug fix nor a feature. MINOR BREAKING CHANGE (package-name): Another breaking change if needed. MAJOR BREAKING CHANGE (package-name): If any breaking changes were done, they need to be listed here. ![]() Type (another-package-name): If the change affects more than one package, it's possible to put multiple entries at once. # ConventionĬommit message template: Type (package-name): A short sentence about the commit. However, it may help you understand how to write a suggested commit message when creating a pull request for CKEditor 5. Therefore, this guide is mainly targeted at core team members. ![]() In the case of ticket branches, only merge commits are analyzed. 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).
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |