We'd love for you to contribute to our source code and to make this project even better than it is today!
If you've found an area whereby this project does not conform to the standards put forward here:
then you can help us by submitting an issue to this repository. The more specific you can be, the better.
All code in this project is developed around the example json:api implementation in the /example folder. You can fire up the example api with:
npm start
If the bug/feature you are working on is in any way controversial, or is an area of the json:api spec that could be misconstrued, I'd encourage you to first open an issue in this repository to enable a discussion to take place before you start changing things. Nobody likes to waste their own time, or anybody elses!
Every pull request that changes code in this project needs to have some form of regression test with it. That might take the shape of some additional asserts in key places within existing tests, it might involve new tests. We write tests to ensure features don't get lost - protect your feature by writing good tests!
To verify all the code changes pass our style guidelines:
npm run lint
To verify everything still behaves as expected:
npm test
To check the code coverage is still great:
npm run coverage
google-chrome ./coverage/lcov-report/index.html
To see code complexity statistics:
npm run complexity
google-chrome ./complexity/index.html
If all of the above comes up good, go ahead and put in a pull request!