CONTRIBUTING.md

Contributing

System Dependencies

Node

• Node.js - v8.0.0+
• npm - v5.0.0+

Install project dependencies

Code

• Fork and clone the hipchat-room-notification-api repo

Install project dependencies

npm install

This installs dependencies from package.json.

npm scripts

npm run lint

This will:

• run linters

npm test

This will:

• run all of the mocha tests

Code guidelines

JS

hipchat-room-notification-api utilizes ESLint to enforce JavaScript standards. Please see the .eslintrc.json file for ESLint config.

• eslint

Checking coding style

Run npm run lint before committing to ensure your changes follow our coding standards.

Versioning

Please use the following commands to increment the package's version numbers EX: Assume current version is 0.0.1

npm version patch --no-git-tag-version

If you run this command the version will increase the patch number (ie 0.0.2)

npm version minor --no-git-tag-version

If you run this command the version will increase the minor number (ie 0.1.0)

npm version major --no-git-tag-version

If you run this command the version will increase the major number (ie 1.0.0)

EditorConfig

EditorConfig helps maintain consistent file formatting between different editors and developers. Please install the plugin for you editor of choice. Please see the .editorconfig file at the root of this repo to see what settings are enforced.

License

Contributions to hipchat-room-notification-api are subject to the MIT License.