summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJason Tedor <jason@tedor.me>2016-05-16 17:34:32 -0400
committerJason Tedor <jason@tedor.me>2016-05-16 17:34:32 -0400
commit0037a579a4b075293ec0143ea0c17aaa75bd1953 (patch)
tree44fcfb62c699777301f5c55a4c83a1c41304ec61 /CONTRIBUTING.md
parente69305ae218593ce9737c84e72e12c99b516ade6 (diff)
Add note to contributing docs about force push
This commit adds a note to the contributing docs regarding force pushing during the review process. Relates #18380
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a79b03f537..4868bbc696 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -71,6 +71,16 @@ Once your changes and tests are ready to submit for review:
Then sit back and wait. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into Elasticsearch.
+Please adhere to the general guideline that you should never force push
+to a publicly shared branch. Once you have opened your pull request, you
+should consider your branch publicly shared. Instead of force pushing
+you can just add incremental commits; this is generally easier on your
+reviewers. If you need to pick up changes from master, you can merge
+master into your branch. A reviewer might ask you to rebase a
+long-running pull request in which case force pushing is okay for that
+request. Note that squashing at the end of the review process should
+also not be done, we can do that if necessary.
+
Contributing to the Elasticsearch codebase
------------------------------------------