Skip to content

Commit f2058cb

Browse files
author
Burcu Dogan
committed
Merge pull request #66 from silvolu/master
DOCS: add CONTRIBUTING.md
2 parents bc14948 + de588df commit f2058cb

File tree

2 files changed

+39
-20
lines changed

2 files changed

+39
-20
lines changed

CONTRIBUTING.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing
2+
3+
Before making any contributions, please sign one of the contributor license agreements below.
4+
5+
Fork the repo, develop and test your code changes.
6+
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+
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+
15+
- **GCLOUD_TESTS_PROJECT_ID**: Developers Console project's ID (e.g. bamboo-shift-455)
16+
- **GCLOUD_TESTS_KEY**: The path to the JSON key file.
17+
18+
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`:
19+
20+
* `gcloud preview datastore create-indexes regression/data/` (from the package root)
21+
22+
Add your (or your organization's name) to AUTHORS and
23+
CONTRIBUTORS files.
24+
25+
## Contributor License Agreements
26+
27+
Before we can accept any pull requests
28+
we have to jump through a couple of legal hurdles,
29+
primarily a Contributor License Agreement (CLA):
30+
31+
- **If you are an individual writing original source code**
32+
and you're sure you own the intellectual property,
33+
then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
34+
- **If you work for a company that wants to allow you to contribute your work**,
35+
then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
36+
37+
You can sign these electronically (just scroll to the bottom).
38+
After that, we'll be able to accept your pull requests.

README.md

+1-20
Original file line numberDiff line numberDiff line change
@@ -485,23 +485,4 @@ sub.close(); // closes the connection, stops listening for messages.
485485

486486
## Contributing
487487

488-
Fork the repo, make changes and open a pull request.
489-
490-
* `npm test` to run tests.
491-
* `npm run cover` to see the test coverage report.
492-
493-
Add your (or your organization's name) to AUTHORS and
494-
CONTRIBUTORS files.
495-
496-
Before we can accept any pull requests
497-
we have to jump through a couple of legal hurdles,
498-
primarily a Contributor License Agreement (CLA):
499-
500-
- **If you are an individual writing original source code**
501-
and you're sure you own the intellectual property,
502-
then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
503-
- **If you work for a company that wants to allow you to contribute your work**,
504-
then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
505-
506-
You can sign these electronically (just scroll to the bottom).
507-
After that, we'll be able to accept your pull requests.
488+
See [CONTRIBUTING](CONTRIBUTING.md).

0 commit comments

Comments
 (0)