Repository: calcite Updated Branches: refs/heads/master 45782ed3e -> 431e803bb
Site: Add instructions for updating PRs based on the discussion in the dev list (Stamatis Zampetakis) The complete discussion can be found at https://mail-archives.apache.org/mod_mbox/calcite-dev/201808.mbox/%3CCA%2BEpF8tsJBXEawKTaXNsQ1dqcDBymxey1FdRWHuAtwWj1pHKWw%40mail.gmail.com%3E Close apache/calcite#790 Project: http://git-wip-us.apache.org/repos/asf/calcite/repo Commit: http://git-wip-us.apache.org/repos/asf/calcite/commit/431e803b Tree: http://git-wip-us.apache.org/repos/asf/calcite/tree/431e803b Diff: http://git-wip-us.apache.org/repos/asf/calcite/diff/431e803b Branch: refs/heads/master Commit: 431e803bbedb97dd16b9ee80d8f3907fa0b49b51 Parents: 45782ed Author: Stamatis Zampetakis <[email protected]> Authored: Sun Aug 12 13:55:07 2018 +0300 Committer: Michael Mior <[email protected]> Committed: Thu Aug 16 13:23:43 2018 -0400 ---------------------------------------------------------------------- site/develop/index.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/calcite/blob/431e803b/site/develop/index.md ---------------------------------------------------------------------- diff --git a/site/develop/index.md b/site/develop/index.md index e7ea318..90e6d2b 100644 --- a/site/develop/index.md +++ b/site/develop/index.md @@ -67,7 +67,7 @@ helps to agree on the general approach. Log a [JIRA case](https://issues.apache.org/jira/browse/CALCITE) for your proposed feature or start a discussion on the dev list. -Fork the github repository, and create a branch for your feature. +Fork the GitHub repository, and create a branch for your feature. Develop your feature and test cases, and make sure that `mvn install` succeeds. (Run extra tests if your change warrants it.) @@ -83,11 +83,33 @@ If your change had multiple commits, use `git rebase -i master` to squash them into a single commit, and to bring your code up to date with the latest on the main line. -Then push your commit(s) to github, and create a pull request from +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. +The pull request may need to be updated (after its submission) for three main +reasons: +1. you identified a problem after the submission of the pull request; +2. the reviewer requested further changes; +3. the Travis CI build failed and the failure is not caused by your changes. + +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. + +When pushing the changes to GitHub, you should refrain from using the `--force` +parameter and its alternatives. You may choose to force push your changes under + certain conditions: + * 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; + * a reviewer has explicitly asked you to perform some modifications that + require the use of the `--force` option. + +In the special case, that the Travis CI build failed and the failure is not +caused by your changes create an empty commit (`git commit --allow-empty`) and +push it. + ## Continuous Integration Testing Calcite has a collection of Jenkins jobs on ASF-hosted infrastructure.
