When contributing to this repository, it is usually a good idea to first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This could potentially save a lot of wasted hours.
Please note we have a code of conduct, please follow it in all your interactions with the project.
All commits on the this repository follow the Conventional Changelog standard. It is a very simple format so you can still write commit messages by hand. However it is highly recommended developers install Commitizen, it extends the git command and will make writing commit messages a breeze. This repository is configured with a local Commitizen configuration script.
npm run commitGetting Commitizen installed globally is usually trivial, just install it via npm. You will also need to install the cz-conventional-changelog adapter which this repository is configured to use.
npm install -g commitizen cz-conventional-changelogBelow is an example of Commitizen in action. It replaces your usual git commit command
with git cz instead. The new command takes all the same arguments however it leads you
through an interactive process to generate the commit message.
Commit messages are used to automatically generate our changelogs, and to ensure commits are searchable in a useful way. So please use the Commitizen tool and adhere to the commit message standard or else we cannot accept Pull Requests without editing them first.
Below is an example of a properly formated commit message.
chore(Commitizen): Made repository Commitizen friendly.
Added standard Commitizen configuration files to the repo along with all the custom rules.
ISSUES CLOSED: #31
- Ensure that install or build dependencies do not appear in any commits in your code branch.
- Ensure all commit messages follow the Conventional Changelog standard explained earlier.
- Your pull request will either be approved or feedback will be given on what needs to be fixed to get approval.