Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(CONTRIBUTING): add info about commitizen #167

Merged
merged 3 commits into from
Apr 5, 2018
Merged

chore(CONTRIBUTING): add info about commitizen #167

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d3c695
chore(CONTRIBUTING): add info about commitizen
jgravois Mar 30, 2018
076d015
/end bold
jgravois Apr 2, 2018
40220c4
noah has eagle :eyes:
jgravois Apr 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down