aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 772aa59a214c2dbecd8b2d278d08ca99a433d9b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# How to submit a bug report

If you received an error message, please include it and any exceptions.

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

We definitely welcome patches and contributions to grpc! Here are some
guideline and information about how to do so.

## 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. For IntelliJ 14, copy the style to
`~/.IdeaIC14/config/codestyles/`, start IntelliJ, go to File > Settings > Code
Style, and set the Scheme to `GoogleStyle`.

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 `./gradlew build` (`gradlew 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.