Skip to content

Commit 69b56cc

Browse files
committed
Some fixes.
1 parent 272420f commit 69b56cc

19 files changed

+119
-63
lines changed

CONTRIBUTING.md

+43-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,46 @@
11
# Contributing Guide
22

3-
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).
4-
5-
1. Contribute to the issue that is the reason you'll be developing in the first place
6-
1. Fork js-data-http
7-
1. `git clone https://github.com/<you>/js-data-http.git`
8-
1. `cd js-data-http; npm install; bower install;`
9-
1. `grunt go` (builds and starts a watch)
10-
1. (in another terminal) `grunt karma:dev` (runs the tests)
3+
## Support
4+
5+
Support questions are handled via [StackOverflow][so], [Slack][slack], and the
6+
[Mailing List][ml]. Ask your questions there.
7+
8+
## Community
9+
- [StackOverflow Channel][so]
10+
- [Slack Chat][slack] [![Slack Status][sl_b]][slack]
11+
- [Announcements](http://www.js-data.io/blog)
12+
- [Mailing List](ml)
13+
- [Issues Tracker](https://github.com/js-data/js-data/issues)
14+
- [GitHub](https://github.com/js-data/js-data)
15+
- [Contributing Guide](https://github.com/js-data/js-data/blob/master/CONTRIBUTING.md)
16+
17+
## Contributing
18+
19+
When submitting bug reports or feature requests on GitHub, please include _as
20+
much detail as possible_.
21+
22+
- good - Your versions of Angular, JSData, etc, relevant console logs, stack
23+
traces, code examples that revealed the issue, etc.
24+
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
25+
[bin](http://jsbin.com/?html,output) that demonstrates the issue
26+
- best - A Pull Request that fixes the issue, including test coverage for the
27+
issue and the fix
28+
29+
### Pull Requests
30+
31+
1. Contribute to the issue/discussion that is the reason you'll be developing in
32+
the first place
33+
1. Fork js-data
34+
1. `git clone [email protected]:<you>/js-data-http.git`
35+
1. `cd js-data-http; npm install;`
1136
1. Write your code, including relevant documentation and tests
12-
1. Submit a PR and we'll review
37+
1. Run `npm test` (build and test)
38+
1. Your code will be linted and checked for formatting, the tests will be run
39+
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
40+
will be committed when a release is cut.
41+
1. Submit your PR and we'll review!
42+
1. Thanks!
43+
44+
[slack]: http://slack.js-data.io
45+
[ml]: https://groups.io/org/groupsio/jsdata
46+
[so]: http://stackoverflow.com/questions/tagged/jsdata

README.md

+17-20
Original file line numberDiff line numberDiff line change
@@ -94,43 +94,40 @@ See [JSData's dependencies](https://github.com/js-data/js-data/blob/master/READM
9494
- [CHANGELOG.md](https://github.com/js-data/js-data-http/blob/master/CHANGELOG.md)
9595

9696
## API Reference
97-
- [DS](http://www.js-data.io/docs/ds)
98-
- [HttpAdapter](http://www.js-data.io/docs/dshttpadapter)
97+
- [js-data](http://api.js-data.io/js-data/)
98+
- [js-data-http](http://api.js-data.io/js-data-http/)
9999

100100
## Support
101101

102-
Support questions are handled via [Stack Overflow][so], [Slack][sl_l], and the
102+
Support questions are handled via [StackOverflow][so], [Slack][slack], and the
103103
[Mailing List][ml]. Ask your questions there.
104104

105105
## Community
106-
- [Stack Overflow][so]
107-
- [Slack chat][sl_l]
106+
- [StackOverflow Channel][so]
107+
- [Slack Chat][slack] [![Slack Status][sl_b]][slack]
108108
- [Announcements](http://www.js-data.io/blog)
109-
- [Mailing List][ml]
110-
- [Issue Tracker](https://github.com/js-data/js-data-http/issues)
111-
- [GitHub](https://github.com/js-data/js-data-http)
112-
- [Contributing Guide](https://github.com/js-data/js-data-http/blob/master/CONTRIBUTING.md)
109+
- [Mailing List](ml)
110+
- [Issues Tracker](https://github.com/js-data/js-data/issues)
111+
- [GitHub](https://github.com/js-data/js-data)
112+
- [Contributing Guide](https://github.com/js-data/js-data/blob/master/CONTRIBUTING.md)
113113

114114
## Contributing
115115

116-
First, support is handled via the [Slack Channel][sl_l] and the
117-
[Mailing List][ml]. Ask your questions there.
118-
119-
When submitting issues on GitHub, please include as much detail as possible to
120-
make debugging quick and easy.
116+
When submitting bug reports or feature requests on GitHub, please include _as
117+
much detail as possible_.
121118

122-
- good - Your versions of js-data, js-data-http, etc., relevant console logs/error,
123-
code examples that revealed the issue
119+
- good - Your versions of Angular, JSData, etc, relevant console logs, stack
120+
traces, code examples that revealed the issue, etc.
124121
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
125122
[bin](http://jsbin.com/?html,output) that demonstrates the issue
126123
- best - A Pull Request that fixes the issue, including test coverage for the
127124
issue and the fix
128125

129-
#### Pull Requests
126+
### Pull Requests
130127

131128
1. Contribute to the issue/discussion that is the reason you'll be developing in
132129
the first place
133-
1. Fork js-data-http
130+
1. Fork js-data
134131
1. `git clone [email protected]:<you>/js-data-http.git`
135132
1. `cd js-data-http; npm install;`
136133
1. Write your code, including relevant documentation and tests
@@ -141,7 +138,7 @@ will be committed when a release is cut.
141138
1. Submit your PR and we'll review!
142139
1. Thanks!
143140

144-
### License
141+
## License
145142

146143
The MIT License (MIT)
147144

@@ -179,4 +176,4 @@ SOFTWARE.
179176
[cod_b]: https://img.shields.io/codacy/3931bbd8d838463297f70640aa78251b.svg
180177
[cod_l]: https://www.codacy.com/app/jasondobry/js-data-http/dashboard
181178
[axios]: https://github.com/mzabriskie/axios
182-
[ml]: https://groups.io/org/groupsio/jsdata
179+
[ml]: https://groups.io/org/groupsio/jsdata

bower.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "js-data-http",
33
"description": "HTTP (XHR) adapter for js-data in the browser.",
4-
"homepage": "http://www.js-data.io/docs/dshttpadapter",
4+
"homepage": "https://github.com/js-data/js-data-http",
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/js-data/js-data-http.git"

dist/js-data-http.js

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/js-data-http.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/js-data-http.min.js

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/js-data-http.min.map

+1-1
Large diffs are not rendered by default.

fetch/dist/js-data-fetch.js

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

fetch/dist/js-data-fetch.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)