Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 830 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 830 Bytes
Raw

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Changes should be proposed as a pull request.

Setup

  1. Install yarn on your system: https://yarnpkg.com/en/docs/install
  2. Run the following commands:
$ git clone https://github.com/RallySoftware/clientmetrics
$ cd clientmetrics
$ yarn
$ yarn run build

Building

$ yarn run build

Testing

$ yarn run test
$ yarn run lint

Generating docs

$ yarn run docs

Pull Requests

We actively welcome your pull requests.

  1. Create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.