#Prefixes # feat (feature) fix (bug fix) docs (documentation) style (formatting, missing semi colons, …) refactor test (when adding missing tests) chore (maintain)
#Sample#
fix(*): fix this thing
Fixing the thing
#Coding Rules#
To ensure consistency throughout the source code, keep these rules in mind as you are working:
All features or bug fixes must be tested by one or more specs (unit-tests). All public API methods must be documented. (Details TBC). We follow Google's JavaScript Style Guide, but wrap all code at 100 characters. An automated formatter is available, see DEVELOPER.md. Commit Message Guidelines We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Angular change log.
Commit Message Format Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
():
The header is mandatory and the scope of the header is optional.Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
The footer should contain a closing reference to an issue if any.
Samples: (even more samples)
docs(changelog): update changelog to beta.5
fix(release): need to depend on latest rxjs and zone.js
The version in our package.json gets copied to the one we publish, and users need the latest of these.
Revert If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit ., where the hash is the SHA of the commit being reverted.
#Type# Must be one of the following:
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs) docs: Documentation only changes feat: A new feature fix: A bug fix perf: A code change that improves performance refactor: A code change that neither fixes a bug nor adds a feature style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) test: Adding missing tests or correcting existing tests
#Scope# The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
The following is the list of supported scopes:
animations bazel benchpress common compiler compiler-cli core elements forms http language-service localize platform-browser platform-browser-dynamic platform-server platform-webworker platform-webworker-dynamic router service-worker upgrade zone.js There are currently a few exceptions to the "use package name" rule:
packaging: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc. changelog: used for updating the release notes in CHANGELOG.md docs-infra: used for docs-app (angular.io) related changes within the /aio directory of the repo dev-infra: used for dev-infra related changes within the directories /scripts, /tools and /dev-infra ngcc: used for changes to the Angular Compatibility Compiler ve: used for changes specific to ViewEngine (legacy compiler/renderer). none/empty string: useful for style, test and refactor changes that are done across all packages (e.g. style: add missing semicolons) and for docs changes that are not related to a specific package (e.g. docs: fix typo in tutorial). Subject The subject contains a succinct description of the change:
use the imperative, present tense: "change" not "changed" nor "changes" don't capitalize the first letter no dot (.) at the end Body Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Footer The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this document.