Read the issue guidlines before opening an issue!
In order to contribute just create your own fork of the repository and then run:
git clone [email protected]:<your_username>/restangular.git
cd restangular
npm install grunt-cli --global
npm install
Create a branch for your code changes
git checkout -b my_awesome_fix
When making changes to the code, please always write a test case for your topic before making the change. Watch the test fail, then implement the change and watch the test succeed.
Tests are run with grunt test.
When you're done with your code, run grunt jshint to check
if you code follow the same simple coding design as the rest of the project.
Consider integrating jshint in your editor to get real time feedback on your
style as you're coding.
Please write your commit messages in the angular conventional changelog format. This will help us to keep a decent CHANGELOG with minimum effort. Check previous commit messages for examples.
If your code change includes new features, please include an update to the README.md explaining your feature.
Don't, however, generate distribution files (the files in dist). This will be done on a regular basis by maintainers as PRs are merged.
Please consider squasing the commits in your topic branch into a single commit including all changes needed. This will make the PR cleaner and the change history more easy to follow after the PR has been merged. Also, the CHANGELOG will make more sense.
Look here and here for how to.
Now you're ready to open a PR.
Thanks!