Syng is a Commitizen Friendly Repository.
When you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time.
Install Commitizen through npm.
npm install -g commitizen
To commit using Commitizen, you must run git cz
instead of git commit
. When working in a Commitizen Friendly repository, git cz
will help you draft formatted commit messages; however, while working in a repository that does not use Commitizen, git cz behaves like git commit.
- Fork it!
- Create a branch
git checkout -b my-feature
- Commit your changes
git cz
- Submit a pull request
Please be as detailed as possible. Provide errors and/or logs where possible. When including enhancements, describe them as clearly as possible and provide links to similar features elsewhere (if possible). Be sure to include the version of Syng you are using, your operating system and architecture, and any other information about your system that may be relevant.
Please document your code as clearly as possible. For variables, use clear and understandable variable names.