Merge pull request #450 from rollbar/447-remove-commitizen

Remove commitizen setup; prefer global usage instead

.gitignore

@@ -2,7 +2,6 @@
 *.swo
 vendor
 composer.lock
-package-lock.json
 .idea
 build
 .vscode

README.md

@@ -45,23 +45,32 @@ For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rol
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git cz`)
+3. Commit your changes (See Conventional Commits below)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Commit message convention
+### Conventional Commits
+This repository follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) guidelines.
+Commit messages should include a prefix describing the commit before the short description.
+Recognized prefixes include: feat, fix, doc, style, refactor, perf, test, build, chore, revert.
+Breaking changes should include 'BREAKING CHANGE'.
 
-This repository follows [The Conventional Changelog](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#specification) specification as the commit message convention.
+Example:
+```
+git commit -m 'feat(bars): add foo support for all bars
 
-## Development tools
+fix #123
+BREAKING CHANGE: bars supporting foo break bars supporting qwerty'
+```
 
-To enable the full range of development tools run:
+Optionally, you can use commitizen to format your commit messages.
+```
+npm install -g commitizen
+npm install -g cz-conventional-changelog
+echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
+```
 
-`npm install commitizen -g && npm install`
-
-### Commitizen
-
-After installing the development tools you will be able to use `git cz` to generate commit messages according to The Conventional Changelog specification.
+And then commit using `git cz`. You'll be prompted for information describing your commit.
 
 # Testing
 Tests are in `tests`.