-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
119 additions
and
63 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,46 @@ | ||
# Contributing Guide | ||
|
||
First, feel free to contact me with questions. [Mailing List](https://groups.io/org/groupsio/jsdata). [Issues](https://github.com/js-data/js-data-http/issues). | ||
|
||
1. Contribute to the issue that is the reason you'll be developing in the first place | ||
1. Fork js-data-http | ||
1. `git clone https://github.com/<you>/js-data-http.git` | ||
1. `cd js-data-http; npm install; bower install;` | ||
1. `grunt go` (builds and starts a watch) | ||
1. (in another terminal) `grunt karma:dev` (runs the tests) | ||
## Support | ||
|
||
Support questions are handled via [StackOverflow][so], [Slack][slack], and the | ||
[Mailing List][ml]. Ask your questions there. | ||
|
||
## Community | ||
- [StackOverflow Channel][so] | ||
- [Slack Chat][slack] [![Slack Status][sl_b]][slack] | ||
- [Announcements](http://www.js-data.io/blog) | ||
- [Mailing List](ml) | ||
- [Issues Tracker](https://github.com/js-data/js-data/issues) | ||
- [GitHub](https://github.com/js-data/js-data) | ||
- [Contributing Guide](https://github.com/js-data/js-data/blob/master/CONTRIBUTING.md) | ||
|
||
## Contributing | ||
|
||
When submitting bug reports or feature requests on GitHub, please include _as | ||
much detail as possible_. | ||
|
||
- good - Your versions of Angular, JSData, etc, relevant console logs, stack | ||
traces, code examples that revealed the issue, etc. | ||
- 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 | ||
|
||
### Pull Requests | ||
|
||
1. Contribute to the issue/discussion that is the reason you'll be developing in | ||
the first place | ||
1. Fork js-data | ||
1. `git clone [email protected]:<you>/js-data-http.git` | ||
1. `cd js-data-http; npm install;` | ||
1. Write your code, including relevant documentation and tests | ||
1. Submit a PR and we'll review | ||
1. Run `npm 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! | ||
|
||
[slack]: http://slack.js-data.io | ||
[ml]: https://groups.io/org/groupsio/jsdata | ||
[so]: http://stackoverflow.com/questions/tagged/jsdata |
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 |
---|---|---|
|
@@ -94,43 +94,40 @@ See [JSData's dependencies](https://github.com/js-data/js-data/blob/master/READM | |
- [CHANGELOG.md](https://github.com/js-data/js-data-http/blob/master/CHANGELOG.md) | ||
|
||
## API Reference | ||
- [DS](http://www.js-data.io/docs/ds) | ||
- [HttpAdapter](http://www.js-data.io/docs/dshttpadapter) | ||
- [js-data](http://api.js-data.io/js-data/) | ||
- [js-data-http](http://api.js-data.io/js-data-http/) | ||
|
||
## Support | ||
|
||
Support questions are handled via [Stack Overflow][so], [Slack][sl_l], and the | ||
Support questions are handled via [StackOverflow][so], [Slack][slack], and the | ||
[Mailing List][ml]. Ask your questions there. | ||
|
||
## Community | ||
- [Stack Overflow][so] | ||
- [Slack chat][sl_l] | ||
- [StackOverflow Channel][so] | ||
- [Slack Chat][slack] [![Slack Status][sl_b]][slack] | ||
- [Announcements](http://www.js-data.io/blog) | ||
- [Mailing List][ml] | ||
- [Issue Tracker](https://github.com/js-data/js-data-http/issues) | ||
- [GitHub](https://github.com/js-data/js-data-http) | ||
- [Contributing Guide](https://github.com/js-data/js-data-http/blob/master/CONTRIBUTING.md) | ||
- [Mailing List](ml) | ||
- [Issues Tracker](https://github.com/js-data/js-data/issues) | ||
- [GitHub](https://github.com/js-data/js-data) | ||
- [Contributing Guide](https://github.com/js-data/js-data/blob/master/CONTRIBUTING.md) | ||
|
||
## Contributing | ||
|
||
First, support is handled via the [Slack Channel][sl_l] and the | ||
[Mailing List][ml]. Ask your questions there. | ||
|
||
When submitting issues on GitHub, please include as much detail as possible to | ||
make debugging quick and easy. | ||
When submitting bug reports or feature requests on GitHub, please include _as | ||
much detail as possible_. | ||
|
||
- good - Your versions of js-data, js-data-http, etc., relevant console logs/error, | ||
code examples that revealed the issue | ||
- good - Your versions of Angular, JSData, etc, relevant console logs, stack | ||
traces, code examples that revealed the issue, etc. | ||
- 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 | ||
|
||
#### Pull Requests | ||
### Pull Requests | ||
|
||
1. Contribute to the issue/discussion that is the reason you'll be developing in | ||
the first place | ||
1. Fork js-data-http | ||
1. Fork js-data | ||
1. `git clone [email protected]:<you>/js-data-http.git` | ||
1. `cd js-data-http; npm install;` | ||
1. Write your code, including relevant documentation and tests | ||
|
@@ -141,7 +138,7 @@ will be committed when a release is cut. | |
1. Submit your PR and we'll review! | ||
1. Thanks! | ||
|
||
### License | ||
## License | ||
|
||
The MIT License (MIT) | ||
|
||
|
@@ -179,4 +176,4 @@ SOFTWARE. | |
[cod_b]: https://img.shields.io/codacy/3931bbd8d838463297f70640aa78251b.svg | ||
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-http/dashboard | ||
[axios]: https://github.com/mzabriskie/axios | ||
[ml]: https://groups.io/org/groupsio/jsdata | ||
[ml]: https://groups.io/org/groupsio/jsdata |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.