aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorCarlos O'Ryan <coryan@google.com>2017-12-08 23:20:55 -0500
committerCarlos O'Ryan <coryan@google.com>2017-12-08 23:20:55 -0500
commitc82cd5e41e3755fc9ed65912ca3acaae69921dbb (patch)
tree269e7853261fdc34b84eaadac646a6c4ac6d8b94 /CONTRIBUTING.md
parent11841175d8023203898e4168c49e80590a19795c (diff)
downloadgoogletest-c82cd5e41e3755fc9ed65912ca3acaae69921dbb.tar.gz
googletest-c82cd5e41e3755fc9ed65912ca3acaae69921dbb.tar.bz2
googletest-c82cd5e41e3755fc9ed65912ca3acaae69921dbb.zip
Also add documentation around becoming a contributor.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..0ac02f5d
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,37 @@
+# How to become a contributor and submit your own code
+
+## Contributor License Agreements
+
+We'd love to accept your patches! Before we can take them, we
+have to jump a couple of legal hurdles.
+
+Please fill out either the individual or corporate Contributor License Agreement
+(CLA).
+
+ * If you are an individual writing original source code and you're sure you
+ own the intellectual property, then you'll need to sign an
+ [individual CLA](https://developers.google.com/open-source/cla/individual).
+ * If you work for a company that wants to allow you to contribute your work,
+ then you'll need to sign a
+ [corporate CLA](https://developers.google.com/open-source/cla/corporate).
+
+Follow either of the two links above to access the appropriate CLA and
+instructions for how to sign and return it. Once we receive it, we'll be able to
+accept your pull requests.
+
+## Contributing A Patch
+
+1. Submit an issue describing your proposed change to the repo in question.
+1. The repo owner will respond to your issue promptly.
+1. If your proposed change is accepted, and you haven't already done so, sign a
+ Contributor License Agreement (see details above).
+1. Fork the desired repo, develop and test your code changes.
+1. Ensure that your code adheres to the existing style in the sample to which
+ you are contributing.
+1. Ensure that your code has an appropriate set of unit tests which all pass.
+1. Submit a pull request.
+
+## Style
+
+Samples in this repository follow the [Google C++ Style Guide](
+https://google.github.io/styleguide/cppguide.html).