aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorEric Anderson <ejona@google.com>2015-03-16 17:55:30 -0700
committerEric Anderson <ejona@google.com>2015-03-16 22:09:48 -0700
commit69cef51ac24ec4431e92027e3e7f006579b77c64 (patch)
treef3ed8c0b1b81bf67792c2024584a136c7b828713 /CONTRIBUTING.md
parent7c6b6271703ff6e62c51094c5a195415db830708 (diff)
downloadgrpc-grpc-java-69cef51ac24ec4431e92027e3e7f006579b77c64.tar.gz
Improve CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md37
1 files changed, 32 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 27d72ab33..30805d6f7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,11 +1,38 @@
-# How to contribute
+# How to submit a bug report
+
+If you received an error message, please include it and any exceptions.
-We definitely welcome patches and contributions to grpc! Here are some guideline
-and information about how to do so.
+We commonly need to know what platform you are on:
+ * JDK/JRE version (i.e., ```java -version```)
+ * Operating system (i.e., ```uname -a```)
+
+# How to contribute
-## Getting started
+We definitely welcome patches and contributions to grpc! Here are some
+guideline and information about how to do so.
-### Legal requirements
+## Before getting started
In order to protect both you and ourselves, you will need to sign the
[Contributor License Agreement](https://cla.developers.google.com/clas).
+
+We follow the [Google Java Style
+Guide](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html). Our
+build automatically will provide warnings for style issues.
+[Eclipse](https://google-styleguide.googlecode.com/svn/trunk/eclipse-java-google-style.xml)
+and
+[IntelliJ](https://google-styleguide.googlecode.com/svn/trunk/intellij-java-google-style.xml)
+style configurations are commonly useful.
+
+If planning on making a large change, feel free to [create an issue on
+GitHub](https://github.com/grpc/grpc-java/issues/new), visit the [#grpc IRC
+channel on Freenode](http://webchat.freenode.net/?channels=grpc), or send an
+email to [grpc-io@googlegroups.com](grpc-io@googlegroups.com) to discuss
+beforehand.
+
+## Proposing changes
+
+Make sure that ```./gradle build``` (```.\gradle.bat build``` on Windows)
+completes successfully without any new warnings. Then create a Pull Request
+with your changes. When the changes are accepted, they will be merged or
+cherry-picked by a gRPC core developer.