# Contributing ## Installation 1. Download `node` at [nodejs.org](http://nodejs.org) and install it, if you haven't already. 1. Clone the repo. ```sh git clone https://github.com/JamieMason/Jasmine-Matchers.git cd Jasmine-Matchers ``` 1. Install dependencies. ```sh npm install ``` ## Adding Matchers Please first [open an issue](https://github.com/JamieMason/Jasmine-Matchers/issues/new) so the idea can be discussed, there are other matcher libraries so this one may not be the best fit. Appropriate matchers are those that are likely to be useful to the majority of Developers, ie. not those which apply only to users of a particular library or framework. Once agreed, the steps at the time of writing are as follows; + Run `npm run watch` to build and test on each file change + Create `test/.spec.js` + Create `src/.js` + Add `: require('./'),` to the `matcher` object in `src/api.js` + Add the new matcher to `README.md` + Run `npm run build` to generate `dist/*.js` ## Running Tests Running `npm run test:local` will run the test suite in Chrome and `npm run test:jest` will do the same in Node.js, this is enough for initial development locally. Before any changes are released, the test suite is runs in hundreds of browser/version combinations using [Browserstack](https://www.browserstack.com/). ## Writing Tests Please take some time to [review the existing tests](https://github.com/JamieMason/Jasmine-Matchers/tree/master/test) to get a feel for what would be considered consistent with the rest of the project. ## Coding Style This project uses [xo: Happiness JavaScript linter](https://github.com/sindresorhus/xo) and can be linted and formatted by running; ```sh npm run lint ``` ## Commit Message Format There are very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history, but also allows us to generate the CHANGELOG.md. Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` ():