aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorŁukasz Strzałkowski <lukasz.strzalkowski@gmail.com>2017-03-03 10:04:04 -0800
committerEric Anderson <ejona@google.com>2017-03-03 10:04:04 -0800
commit5410b4c6243585327d15604ba231462dded8e123 (patch)
tree73af9c3089930044476494a1fef50e96934a5cd4 /CONTRIBUTING.md
parentafb82b47fa66f94ffea48ccead7b4e9ea5537f16 (diff)
downloadgrpc-grpc-java-5410b4c6243585327d15604ba231462dded8e123.tar.gz
core: update contributing guidelines w/ pr/commit conventions
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 223300b77..ad2695a1b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,6 +32,28 @@ 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.
+## Pull Requests & Commits
+
+We have few conventions for keeping history clean and making code reviews easier
+for reviewers:
+
+* First line of commit messages should be in format of
+
+ `package-name: summary of change`
+
+ where the summary finishes the sentence: `This commit improves gRPC to ____________.`
+
+ for example:
+
+ `core,netty,interop-testing: add capacitive duractance to turbo encabulators`
+
+* Every time you receive a feedback on your pull request, push changes that
+ address it as a separate one or multiple commits with a descriptive commit
+ message (try avoid using vauge `addressed pr feedback` type of messages).
+
+ Project maintainers are obligated to squash those commits into one
+ merging.
+
## Proposing changes
Make sure that `./gradlew build` (`gradlew build` on Windows) completes