Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 1.27 KB

Contributing Guide

First, support is handled via the Gitter 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

Github Issues.

Submitting Pull Requests

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