Skip to content

Commit 5d22b9b

Browse files
committed
Merge pull request #38 from js-data/develop
Update CONTRIBUTING.md
2 parents db45130 + ec58392 commit 5d22b9b

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
11
# Contributing Guide
22

3-
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.
3+
First, support is handled via the [Slack Channel](http://slack.js-data.io) and
4+
the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions
5+
there.
46

5-
When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
7+
When submitting issues on GitHub, please include as much detail as possible to
8+
make debugging quick and easy.
69

7-
- good - Your versions of js-data, js-data-sql, etc., relevant console logs/error, code examples that revealed the issue
8-
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
9-
- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
10+
- good - Your versions of js-data, js-data-sql, etc., relevant console
11+
logs/error, code examples that revealed the issue
12+
- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or
13+
[bin](http://jsbin.com/?html,output) that demonstrates the issue
14+
- best - A Pull Request that fixes the issue, including test coverage for the
15+
issue and the fix
1016

1117
[Github Issues](https://github.com/js-data/js-data-sql/issues).
1218

1319
#### Submitting Pull Requests
1420

15-
1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
21+
1. Contribute to the issue/discussion that is the reason you'll be developing in
22+
the first place
1623
1. Fork js-data-sql
1724
1. `git clone [email protected]:<you>/js-data-sql.git`
1825
1. `cd js-data-sql; npm install;`
1926
1. Write your code, including relevant documentation and tests
2027
1. Run `npm test` (build and test)
2128
- You need io.js or Node 4.x that includes generator support without a flag
2229
1. Your code will be linted and checked for formatting, the tests will be run
23-
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
30+
1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
31+
will be committed when a release is cut.
2432
1. Submit your PR and we'll review!
2533
1. Thanks!
2634

@@ -30,10 +38,13 @@ Here's how to make a release on the `master` branch:
3038

3139
1. Bump `package.json` to the appropriate version.
3240
1. `npm test` must succeed.
33-
1. This time, the built `dist/js-data-sql.js` file _will_ be committed, so stage its changes.
41+
1. This time, the built `dist/js-data-sql.js` file _will_ be committed, so stage
42+
its changes.
3443
1. Mention the release version in the commit message, e.g. `Stable Version 1.2.3`
3544
1. Push to master.
3645
1. Create a git tag. Name it the version of the release, e.g. `1.2.3`
37-
- Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.
38-
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the tag on your local machine.
46+
- Easiest way is to just create a GitHub Release, which will create the tag
47+
for you. Name the Release and the git tag the same thing.
48+
1. `git fetch origin` if you tagged it via GitHub Release, so you can get the
49+
tag on your local machine.
3950
1. `npm publish .` (Make sure you got the version bumped correctly!)

0 commit comments

Comments
 (0)