|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -Before making any contributions, please sign one of the contributor license agreements below. |
| 3 | +1. **Please sign one of the contributor license agreements below.** |
| 4 | +2. Fork the repo, develop and test your code changes. |
| 5 | +3. Add your (or your organization's) name to the AUTHORS and CONTRIBUTORS files. |
| 6 | +4. Send a pull request. |
4 | 7 |
|
5 |
| -Fork the repo, develop and test your code changes. |
| 8 | +## Testing |
6 | 9 |
|
7 |
| -* `npm test` to run tests. |
8 |
| -* `npm run regression-test` to run regression tests. |
9 |
| -* `npm run cover` to see the test coverage report. |
| 10 | +``` sh |
| 11 | +# Run the tests. |
| 12 | +$ npm test |
10 | 13 |
|
11 |
| -To run the regression tests, first create and configure a project following the [instructions on how to run gcloud-node] |
12 |
| -(README.md#elsewhere). |
13 |
| -After that, set the following environment variables: |
| 14 | +# Run the regression tests. |
| 15 | +$ npm run regression-test |
| 16 | + |
| 17 | +# See the test coverage report. |
| 18 | +$ npm run cover |
| 19 | +``` |
| 20 | + |
| 21 | +To run the regression tests, first create and configure a project following the [instructions on how to run gcloud-node][elsewhere]. After that, set the following environment variables: |
14 | 22 |
|
15 | 23 | - **GCLOUD_TESTS_PROJECT_ID**: Developers Console project's ID (e.g. bamboo-shift-455)
|
16 | 24 | - **GCLOUD_TESTS_BUCKET_NAME**: The name of the bucket to use for the Cloud Storage API tests
|
17 | 25 | - **GCLOUD_TESTS_KEY**: The path to the JSON key file.
|
18 | 26 |
|
19 |
| -Lastly, create the indexes used in the datastore regression tests using the [gcloud command-line tool](https://developers.google.com/cloud/sdk/gcloud/) and the indexes that you can find in `regression/data/index/yaml`: |
| 27 | +Lastly, create the indexes used in the datastore regression tests using the [gcloud command-line tool][gcloudcli] and the indexes found in `regression/data/index/yaml`: |
20 | 28 |
|
21 |
| -* `gcloud preview datastore create-indexes regression/data/` (from the package root) |
22 |
| - |
23 |
| -Add your (or your organization's name) to AUTHORS and |
24 |
| -CONTRIBUTORS files. |
| 29 | +``` sh |
| 30 | +# From the project's root directory: |
| 31 | +$ gcloud preview datastore create-indexes regression/data/ |
| 32 | +``` |
25 | 33 |
|
26 | 34 | ## Contributor License Agreements
|
27 | 35 |
|
28 |
| -Before we can accept any pull requests |
29 |
| -we have to jump through a couple of legal hurdles, |
30 |
| -primarily a Contributor License Agreement (CLA): |
| 36 | +Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA): |
| 37 | + |
| 38 | +- **If you are an individual writing original source code** and **you own the intellectual property**, then you'll need to sign an [individual CLA][indvcla]. |
| 39 | +- **If you work for a company that wants to allow you to contribute your work**, then you'll need to sign a [corporate CLA][corpcla]. |
31 | 40 |
|
32 |
| -- **If you are an individual writing original source code** |
33 |
| - and you're sure you own the intellectual property, |
34 |
| - then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). |
35 |
| -- **If you work for a company that wants to allow you to contribute your work**, |
36 |
| - then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). |
| 41 | +You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests. |
37 | 42 |
|
38 |
| -You can sign these electronically (just scroll to the bottom). |
39 |
| -After that, we'll be able to accept your pull requests. |
| 43 | +[elsewhere]: README.md#elsewhere |
| 44 | +[gcloudcli]: https://developers.google.com/cloud/sdk/gcloud/ |
| 45 | +[indvcla]: https://developers.google.com/open-source/cla/individual |
| 46 | +[corpcla]: https://developers.google.com/open-source/cla/corporate |
0 commit comments