Submission format:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The information for each submission should not exceed 100 characters.
The submission information includes a header, body, and footer, with the header being mandatory.
Header#
The format is as follows:
<type>(<scope>): <subject>
Where <scope> is optional and can be any content that specifies the location of the changes made.
<type> should be one of the following:
- build: Changes to the build system or external dependencies
- ci: Changes to CI configuration files or scripts
- docs: Changes to documentation
- feat: Adding new features
- fix: Bug fixes
- perf: Code changes that improve performance
- refactor: Code refactoring
- style: Changes that do not affect the meaning of the code, such as whitespace, formatting, missing semicolons, etc.
- test: Adding tests or modifying test code
<subject> should provide a concise description of the changes made, following these guidelines:
- Use imperative, present tense
- Do not capitalize the first letter
- Do not add a period at the end
Body#
Similar to the subject, use imperative, present tense.
Generally, it should include the motivation for the changes and a comparison with the previous behavior.
Footer#
Any breaking changes must be mentioned in the footer as a breaking change block, starting with BREAKING CHANGE:, followed by a space or two line breaks. The rest of the information is a description of the changes made, the reasons for the changes, and any additional comments.
BREAKING CHANGE: isolate scope bindings definition has changed and
the inject option for the directive controller injection was removed.
To migrate the code follow the example below:
Before:
...
...
After:
...
...
The removed `inject` wasn't generally useful for directives, so there should be no code using it.
If the purpose of this submission is to modify an issue, the issue should be referenced in the footer, starting with the keyword Closes, for example:
Closes #234
Multiple issues should be separated by commas, for example:
Closes #123, #245, #992
If the submission includes a rollback (revert) operation, the footer should start with revert:, and the body should include This reverts commit hash, where the hash value represents the commit being rolled back.
revert:<type>(<scope>): <subject>
<BLANK LINE>
This reverts commit hash
<other-body>
<BLANK LINE>
<footer>