From 9477de1e7eb7e921ab30b6e618b4bcddc641d06d Mon Sep 17 00:00:00 2001 From: john gravois Date: Thu, 5 Apr 2018 14:22:02 -0700 Subject: [PATCH] chore(CONTRIBUTING): add info about commitizen (#167) * chore(CONTRIBUTING): add info about commitizen ISSUES CLOSED: #147 * /end bold * noah has eagle :eyes: --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c389fe79b..41ba0a10a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,12 @@ You don't _have to_ but we recommend installing TypeScript, TSLint, Prettier and You can run _all_ the tests with `npm test`. * `npm run test:chrome:debug` runs the Karma tests in Chrome and watches for changes. In the opened Chrome window you can click "Debug" and refresh the page to enter the debugger for tests. Note that you will be debugging the compiled JS files until https://github.com/monounity/karma-typescript/issues/144 is resolved. -* `npm run test:node:debug` run the node tests, automatically opening the Chrome debugger. This is great for debugging the tests while you are working. **REQUIRES CHROME 60+*. This also means you can do you really stupid things like run this in an infinite loop with `while :; do npm run test:node:debug; sleep 1; done` which will reopen the chrome debugger once the current one closes. +* `npm run test:node:debug` run the node tests, automatically opening the Chrome debugger. This is great for debugging the tests while you are working. **REQUIRES CHROME 60+**. This also means you can do you really stupid things like run this in an infinite loop with `while :; do npm run test:node:debug; sleep 1; done` which will reopen the chrome debugger once the current one closes. + +### Formatting commit messsages +Using [`npm run c`](https://github.com/Esri/arcgis-rest-js/blob/fd9005fef74c33c684273fd283aa6bd9990e8630/package.json#L110) (instead of `git commit`) create messages our handy [script](https://github.com/Esri/arcgis-rest-js/blob/master/support/changelog.js) can parse to categorize your bug fix, new feature or breaking change and associate it with relevant packages in our [CHANGELOG](CHANGELOG.md) automatically. + +This isn't mandatory, but it is pretty cool. :sparkles: ### Building the documentation site locally.