Skip to content

Commit d16f75d

Browse files
committed
another update to CONTRIBUTING.md
1 parent 0ce151b commit d16f75d

File tree

1 file changed

+46
-44
lines changed

1 file changed

+46
-44
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,15 @@ possible. Hopefully this document makes the process for contributing clear and
66
answers any questions you may have. If not, feel free to open an
77
[Issue](https://github.com/facebook/graphql/issues).
88

9-
## Getting Started
10-
11-
1. Fork this repo by using the "Fork" button in the upper-right
12-
13-
2. Check out your fork
14-
15-
```sh
16-
git clone [email protected]:yournamehere/graphql-js.git
17-
```
18-
19-
3. Install all dependencies
20-
21-
```sh
22-
npm install
23-
```
24-
25-
4. Get coding! If you've added code, add tests. If you've changed APIs, update
26-
any relevant documentation or tests.
27-
28-
5. Ensure all tests pass
29-
30-
```sh
31-
npm test
32-
```
33-
34-
### Live Feedback
35-
36-
While actively developing, we recommend running `npm run watch` in a terminal.
37-
This will watch the file system run any relevant lint, tests, and type checks automatically whenever you save a `.js` file.
38-
39-
### Release on NPM
9+
## Issues
4010

41-
*Only core contributors may release to NPM.*
11+
We use GitHub issues to track public bugs and requests. Please ensure your bug
12+
description is clear and has sufficient instructions to be able to reproduce the
13+
issue. The best way is to provide a reduced test case on jsFiddle or jsBin.
4214

43-
To release a new version on NPM, use `npm version patch|minor|major` in order
44-
to increment the version in package.json and tag and commit a release. Then
45-
`git push --tags` this change so Travis CI can deploy to NPM. *Do not run
46-
`npm publish` directly.* Once published, add
47-
[release notes](https://github.com/graphql/graphql-js/tags). Use [semver](http://semver.org/) to determine which version to increment.
15+
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
16+
disclosure of security bugs. In those cases, please go through the process
17+
outlined on that page and do not file a public issue.
4818

4919
## Pull Requests
5020

@@ -66,15 +36,36 @@ to do this once to work on any of Facebook's open source projects.
6636

6737
Complete your CLA here: <https://code.facebook.com/cla>
6838

69-
## Issues
39+
### Getting Started
7040

71-
We use GitHub issues to track public bugs and requests. Please ensure your bug
72-
description is clear and has sufficient instructions to be able to reproduce the
73-
issue. The best way is to provide a reduced test case on jsFiddle or jsBin.
41+
1. Fork this repo by using the "Fork" button in the upper-right
7442

75-
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
76-
disclosure of security bugs. In those cases, please go through the process
77-
outlined on that page and do not file a public issue.
43+
2. Check out your fork
44+
45+
```sh
46+
git clone [email protected]:yournamehere/graphql-js.git
47+
```
48+
49+
3. Update or install all dependencies
50+
51+
```sh
52+
npm update
53+
```
54+
55+
4. Get coding! If you've added code, add tests. If you've changed APIs, update
56+
any relevant documentation or tests. Ensure your work is committed within a
57+
feature branch.
58+
59+
5. Ensure all tests pass
60+
61+
```sh
62+
npm test
63+
```
64+
65+
### Live Feedback
66+
67+
While actively developing, we recommend running `npm run watch` in a terminal.
68+
This will watch the file system run any relevant lint, tests, and type checks automatically whenever you save a `.js` file.
7869

7970
## Coding Style
8071

@@ -87,6 +78,17 @@ outlined on that page and do not file a public issue.
8778
* Trailing commas,
8879
* Avd abbr wrds.
8980

81+
## Release on NPM
82+
83+
*Only core contributors may release to NPM.*
84+
85+
To release a new version on NPM, first ensure all tests pass with `npm test`,
86+
then use `npm version patch|minor|major` in order to increment the version in
87+
package.json and tag and commit a release. Then `git push --tags` this change so
88+
Travis CI can deploy to NPM. *Do not run `npm publish` directly.*
89+
Once published, add [release notes](https://github.com/graphql/graphql-js/tags).
90+
Use [semver](http://semver.org/) to determine which version to increment.
91+
9092
## License
9193

9294
By contributing to graphql-js, you agree that your contributions will be

0 commit comments

Comments
 (0)