Author: jhyde
Date: Tue Sep 18 05:52:20 2018
New Revision: 1841190
URL: http://svn.apache.org/viewvc?rev=1841190&view=rev
Log:
Site: Add instructions for updating PRs based on the discussion in the dev list
(Stamatis Zampetakis)
Modified:
calcite/site/develop/index.html
Modified: calcite/site/develop/index.html
URL:
http://svn.apache.org/viewvc/calcite/site/develop/index.html?rev=1841190&r1=1841189&r2=1841190&view=diff
==============================================================================
--- calcite/site/develop/index.html (original)
+++ calcite/site/develop/index.html Tue Sep 18 05:52:20 2018
@@ -135,7 +135,7 @@ helps to agree on the general approach.
<a href="https://issues.apache.org/jira/browse/CALCITE";>JIRA case</a> for your
proposed feature or start a discussion on the dev list.</p>
-<p>Fork the github repository, and create a branch for your feature.</p>
+<p>Fork the GitHub repository, and create a branch for your feature.</p>
<p>Develop your feature and test cases, and make sure that
<code class="highlighter-rouge">mvn install</code> succeeds. (Run extra tests
if your change warrants it.)</p>
@@ -149,11 +149,37 @@ the JIRA case number, like this:</p>
squash them into a single commit, and to bring your code up to date
with the latest on the main line.</p>
-<p>Then push your commit(s) to github, and create a pull request from
+<p>Then push your commit(s) to GitHub, and create a pull request from
your branch to the calcite master branch. Update the JIRA case
to reference your pull request, and a committer will review your
changes.</p>
+<p>The pull request may need to be updated (after its submission) for three
main
+reasons:</p>
+<ol>
+ <li>you identified a problem after the submission of the pull request;</li>
+ <li>the reviewer requested further changes;</li>
+ <li>the Travis CI build failed and the failure is not caused by your
changes.</li>
+</ol>
+
+<p>In order to update the pull request, you need to commit the changes in your
+branch and then push the commit(s) to GitHub. You are encouraged to use regular
+ (non-rebased) commits on top of previously existing ones.</p>
+
+<p>When pushing the changes to GitHub, you should refrain from using the <code
class="highlighter-rouge">--force</code>
+parameter and its alternatives. You may choose to force push your changes under
+ certain conditions:</p>
+<ul>
+ <li>the pull request has been submitted less than 10 minutes ago and there
is no
+ pending discussion (in the PR and/or in JIRA) concerning it;</li>
+ <li>a reviewer has explicitly asked you to perform some modifications that
+ require the use of the <code class="highlighter-rouge">--force</code>
option.</li>
+</ul>
+
+<p>In the special case, that the Travis CI build failed and the failure is not
+caused by your changes create an empty commit (<code
class="highlighter-rouge">git commit --allow-empty</code>) and
+push it.</p>
+
<h2 id="continuous-integration-testing">Continuous Integration Testing</h2>
<p>Calcite has a collection of Jenkins jobs on ASF-hosted infrastructure.
