Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 920 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 920 Bytes

Contributing to this module

I'm using Mocha as my test running and Chai as my assertion library.

In order to test the module, you simply need to run

npm test

This will start the grunt task that

  • Checks that everything passes JSHint
  • Runs the Mocha tests

Test API Client

Rather than maintain a Basecamp project for testing against and to avoid the time overhead of such an API, I'm using a Test API Client that mocks responses to requests. It's based on a series of fixtures that represent each part of the API. Each fixture contains mock data and will provide a list of the endpoints that it mocks (as well as implementations for each of those endpoints).

Submitting updates

This is simple. Fork this repo, make your change, make sure it passes, submit a pull request. I'll review it and then accept it if we're both happy with the end result.