-
Notifications
You must be signed in to change notification settings - Fork 78
Commit Guideline
Note: The following contributing guideline was taken from CVWO contribution guideline created by Zhu Hanming
It is strongly recommended for the team to follow a set of commit guidelines.
The following guidelines were adapted from AngularJS.
Contributions include code, documentation, answering user questions, and running the project's infrastructure. This guide explains the process for contributing to this project's core Github Repository and describes what to expect at each step.
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.
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:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 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.jsThe version in our package.json gets copied to the one we publish, and users need the latest of these.
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 <hash>., where the hash is the SHA of the commit being reverted.
We follow semantic commit messages. Check this website for more information.
Must be one of the following:
- chore: Changes to our project configuration files and scripts, such as CI or CD pipelines (example scopes: Travis, Circle)
- 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
The scope should be the name of the file affected (as perceived by the person reading the change-log generated from commit messages.)
Sample, where Routes is the scope:
feat(Routes): add new Main route skeletonThe subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalise the first letter
- no dot (.) at the end
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 behaviour.
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 new lines. The rest of the commit message is then used for this.
feat(Service): add new ApiService helper class
ApiService helps to [insert justification here]
- Some detail of what this does
- More details
Closes #123
Breaks foo.baz api, foo.qux should be used instead