-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Stable Version 3.1.0
- Loading branch information
Showing
10 changed files
with
294 additions
and
202 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,24 @@ | ||
# Contributing Guide | ||
|
||
First, feel free to contact me with questions. [Mailing List](https://groups.google.com/forum/?fromgroups#!forum/js-data-angular). [Issues](https://github.com/js-data/js-data-angular/issues). | ||
First, support is handled via the [Gitter Channel](https://gitter.im/js-data/js-data) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there. | ||
|
||
1. Contribute to the issue that is the reason you'll be developing in the first place | ||
When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy. | ||
|
||
- good - Your versions of Angular, js-data, js-data-angular, etc., relevant console logs/error, code examples that revealed the issue | ||
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue | ||
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix | ||
|
||
[Github Issues](https://github.com/js-data/js-data-angular/issues). | ||
|
||
#### Submitting Pull Requests | ||
|
||
1. Contribute to the issue/discussion that is the reason you'll be developing in the first place | ||
1. Fork js-data-angular | ||
1. `git clone https://github.com/<you>/js-data-angular.git` | ||
1. `git clone git@github.com:<you>/js-data-angular.git` | ||
1. `cd js-data-angular; npm install; bower install;` | ||
1. `grunt go` (builds and starts a watch) | ||
1. (in another terminal) `grunt karma:dev` (runs the tests) | ||
1. Write your code, including relevant documentation and tests | ||
1. Submit a PR and we'll review | ||
1. Run `grunt test` (build and test) | ||
1. Your code will be linted and checked for formatting, the tests will be run | ||
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut. | ||
1. Submit your PR and we'll review! | ||
1. Thanks! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.