We would love for you to contribute to {{template}} and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
Each branch name consists of a type and a subject. The format is expressed in the following example:
<type>/<subject>
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- refac: A code change that neither fixes a bug nor adds a feature
The subject contains a succinct description of the branch:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
Before you submit your Pull Request (PR) consider the following guidelines:
-
Make your changes in a new git branch:
git checkout -b fix/my-fix-branch master
-
Create your patch.
-
Follow our Coding Rules.
-
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes should be consistent across the project.
git commit -a
Note: the optional commit
-acommand line option will automatically "add" and "rm" edited files. -
Push your branch to GitHub:
git push origin fix/my-fix-branch
-
In Gitlab, send a pull request to
{{template}}:master. -
Wait for reviewers and aprooves.
That's it! Thank you for your contribution!
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete fix/my-fix-branch
-
Check out the master branch:
git checkout master -f
-
Delete the local branch:
git branch -D fix/my-fix-branch
-
Update your master with the latest upstream version:
git pull --ff upstream master
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.
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>
<optionalbody>
<optional footer>
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:
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.
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.
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
- refac: 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 service or section of the application affected (as perceived by the person reading the changelog generated from commit messages).
The following is the list of supported scopes:
- here
- you
- should
- populate
- with
- a
- list
- of
- possible
- scopes
There are currently a few exceptions to the "use package name" rule:
- none/empty string: useful for
style,testandrefactorchanges that are done across all portions (e.g.style: add missing semicolons) and for docs changes that are not related to a specific portion (e.g.docs: fix typo in tutorial).
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
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.
The footer should contain any information about Breaking Changes and is also the place to to add a possible [skip ci] tag to avoid running a pipeline.
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][commit-message-format].