Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 822 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (11 loc) · 822 Bytes

Contributing to JSONAPI Mapper

We would love for you to contribute and help make the Mapper a better tool for your JSONAPI needs. You can open an issue to make questions and requests, also find us on gitter to chat with us (we don't bite!).

If you wan't to hack in the code and get your hands dirty keep reading...

Setup for development

As easy as it gets:

  • Have git, node, and npm ready
  • Clone this repo: git clone [email protected]:scoutforpets/jsonapi-mapper
  • Install dependencies: npm install. This will also run the prepublish script running TypeScript-specific tasks
  • Profit!

Running tests

Just run npm test. The tests are also in TypeScript made under the Jasmine framework.