You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by da...@apache.org on 2017/02/28 00:18:23 UTC
[1/3] beam-site git commit: Add contrib guide comments about using
squash & force push.
Repository: beam-site
Updated Branches:
refs/heads/asf-site 2bb190260 -> 70682771d
Add contrib guide comments about using squash & force push.
Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/2f35897a
Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/2f35897a
Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/2f35897a
Branch: refs/heads/asf-site
Commit: 2f35897a244c5ff0b73f822335a6881ef210f519
Parents: 2bb1902
Author: Stephen Sisk <si...@google.com>
Authored: Fri Feb 24 14:44:09 2017 -0800
Committer: Davor Bonaci <da...@google.com>
Committed: Mon Feb 27 16:17:47 2017 -0800
----------------------------------------------------------------------
src/contribute/contribution-guide.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/beam-site/blob/2f35897a/src/contribute/contribution-guide.md
----------------------------------------------------------------------
diff --git a/src/contribute/contribution-guide.md b/src/contribute/contribution-guide.md
index 83d92fc..a959feb 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -186,9 +186,9 @@ Periodically while you work, and certainly before submitting a pull request, you
Remember to always use `--rebase` parameter to avoid extraneous merge commits.
-To push your local, committed changes to your (forked) repository on GitHub, run:
+Then you can push your local, committed changes to your (forked) repository on GitHub. Since rebase may change that branch's history, you may need to force push. You'll run:
- $ git push <GitHub_user> <my-branch>
+ $ git push <GitHub_user> <my-branch> --force
### Testing
All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring.
@@ -201,10 +201,12 @@ For contributions to the Java code, run unit tests locally via Maven. Alternativ
Once the initial code is complete and the tests pass, it\u2019s time to start the code review process. We review and discuss all code, no matter who authors it. It\u2019s a great way to build community, since you can learn from other developers, and they become familiar with your contribution. It also builds a strong project by encouraging a high quality bar and keeping code consistent throughout the project.
### Create a pull request
-Organize your commits to make your reviewer\u2019s job easier. Use the following command to re-order, squash, edit, or change description of individual commits.
+Organize your commits to make your reviewer\u2019s job easier. Reviewers normally prefer multiple small pull requests, instead of a single large pull request. Within a pull request, a relatively small number of commits that break the problem into logical steps is preferred. For most pull requests, you'll squash your changes down to 1 commit. You can use the following command to re-order, squash, edit, or change description of individual commits.
$ git rebase -i origin/master
+You'll then push to your branch on GitHub. Note: when updating your commit after pull request feedback and use squash to get back to one commit, you will need to do a force submit to the branch on your repo.
+
Navigate to the [Beam GitHub mirror](https://github.com/apache/beam) to create a pull request. The title of the pull request should be strictly in the following format:
[BEAM-<JIRA-issue-#>] <Title of the pull request>
[2/3] beam-site git commit: Regenerate website
Posted by da...@apache.org.
Regenerate website
Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/582a7f45
Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/582a7f45
Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/582a7f45
Branch: refs/heads/asf-site
Commit: 582a7f452eed30d815cfddc6af331812e63ccf61
Parents: 2f35897
Author: Davor Bonaci <da...@google.com>
Authored: Mon Feb 27 16:18:18 2017 -0800
Committer: Davor Bonaci <da...@google.com>
Committed: Mon Feb 27 16:18:18 2017 -0800
----------------------------------------------------------------------
content/contribute/contribution-guide/index.html | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/beam-site/blob/582a7f45/content/contribute/contribution-guide/index.html
----------------------------------------------------------------------
diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html
index 580b7e6..5f8ec98 100644
--- a/content/contribute/contribution-guide/index.html
+++ b/content/contribute/contribution-guide/index.html
@@ -419,9 +419,9 @@ $ git checkout -b <my-branch> origin/master
<p>Remember to always use <code class="highlighter-rouge">--rebase</code> parameter to avoid extraneous merge commits.</p>
-<p>To push your local, committed changes to your (forked) repository on GitHub, run:</p>
+<p>Then you can push your local, committed changes to your (forked) repository on GitHub. Since rebase may change that branch\u2019s history, you may need to force push. You\u2019ll run:</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>$ git push <GitHub_user> <my-branch>
+<div class="highlighter-rouge"><pre class="highlight"><code>$ git push <GitHub_user> <my-branch> --force
</code></pre>
</div>
@@ -438,12 +438,14 @@ $ git checkout -b <my-branch> origin/master
<p>Once the initial code is complete and the tests pass, it\u2019s time to start the code review process. We review and discuss all code, no matter who authors it. It\u2019s a great way to build community, since you can learn from other developers, and they become familiar with your contribution. It also builds a strong project by encouraging a high quality bar and keeping code consistent throughout the project.</p>
<h3 id="create-a-pull-request">Create a pull request</h3>
-<p>Organize your commits to make your reviewer\u2019s job easier. Use the following command to re-order, squash, edit, or change description of individual commits.</p>
+<p>Organize your commits to make your reviewer\u2019s job easier. Reviewers normally prefer multiple small pull requests, instead of a single large pull request. Within a pull request, a relatively small number of commits that break the problem into logical steps is preferred. For most pull requests, you\u2019ll squash your changes down to 1 commit. You can use the following command to re-order, squash, edit, or change description of individual commits.</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ git rebase -i origin/master
</code></pre>
</div>
+<p>You\u2019ll then push to your branch on GitHub. Note: when updating your commit after pull request feedback and use squash to get back to one commit, you will need to do a force submit to the branch on your repo.</p>
+
<p>Navigate to the <a href="https://github.com/apache/beam">Beam GitHub mirror</a> to create a pull request. The title of the pull request should be strictly in the following format:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>[BEAM-<JIRA-issue-#>] <Title of the pull request>
[3/3] beam-site git commit: This closes #166
Posted by da...@apache.org.
This closes #166
Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/70682771
Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/70682771
Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/70682771
Branch: refs/heads/asf-site
Commit: 70682771d6bb8ca590e4b04b9943c3b50348496a
Parents: 2bb1902 582a7f4
Author: Davor Bonaci <da...@google.com>
Authored: Mon Feb 27 16:18:18 2017 -0800
Committer: Davor Bonaci <da...@google.com>
Committed: Mon Feb 27 16:18:18 2017 -0800
----------------------------------------------------------------------
content/contribute/contribution-guide/index.html | 8 +++++---
src/contribute/contribution-guide.md | 8 +++++---
2 files changed, 10 insertions(+), 6 deletions(-)
----------------------------------------------------------------------