Contributing Guide

First, support is handled via the Slack Channel and the Mailing List. Ask your questions there.

When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.

good - Your versions of Angular, JSData, etc, relevant console logs/error, code examples that revealed the issue
better - A plnkr, fiddle, or bin that demonstrates the issue
best - A Pull Request that fixes the issue, including test coverage for the issue and the fix

Submitting Pull Requests

Contribute to the issue/discussion that is the reason you'll be developing in the first place
Fork js-data
git clone [email protected]:<you>/js-data.git
cd js-data; npm install; bower install;
Write your code, including relevant documentation and tests
Run npm test (build and test)
Your code will be linted and checked for formatting, the tests will be run
The dist/ folder & files will be generated, do NOT commit dist/*! They will be committed when a release is cut.
Submit your PR and we'll review!
Thanks!

Have write access?

To cut a release:

Checkout master
Bump version in package.json appropriately
Run npm test
Update CHANGELOG.md appropriately
Commit and push changes, including the dist/ folder
Make a GitHub release

set tag name to version
set release name to version
set release body to changelog entry for the version
attach the files in the dist/ folder

git fetch origin
npm publish .