You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by vr...@apache.org on 2015/11/12 23:41:19 UTC
[1/2] incubator-apex-site git commit: Changed contributor guidelines
Repository: incubator-apex-site
Updated Branches:
refs/heads/master 7e2788684 -> c8d5f6fcd
Changed contributor guidelines
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/82c613da
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/82c613da
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/82c613da
Branch: refs/heads/master
Commit: 82c613da88aed189b44cc6762eb616264ed9e120
Parents: 670efbc
Author: Chandni Singh <cs...@apache.org>
Authored: Wed Nov 11 17:19:03 2015 -0800
Committer: Chandni Singh <cs...@apache.org>
Committed: Thu Nov 12 14:22:24 2015 -0800
----------------------------------------------------------------------
src/md/contributing.md | 59 ++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 55 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/82c613da/src/md/contributing.md
----------------------------------------------------------------------
diff --git a/src/md/contributing.md b/src/md/contributing.md
index f7ccad1..a510b4a 100644
--- a/src/md/contributing.md
+++ b/src/md/contributing.md
@@ -10,14 +10,65 @@ This project welcomes new contributors. If you would like to help by adding new
1. Create a [JIRA](https://malhar.atlassian.net/) for the work you plan to do (or assign yourself to an existing JIRA ticket)
1. Fork the ASF github mirror (one time step):
- https://github.com/apache/incubator-apex-core/
-1. Create a new branch from the [devel-3](https://github.com/apache/incubator-apex-core/tree/devel-3) branch. **Name your branch with the JIRA number in it, e.g. `APEX-123.my-feature`.**
+ https://github.com/apache/incubator-apex-core/
+1. Clone the **fork** on your local workspace (one time step):
+ `git clone https://github.com/{github_username}/incubator-apex-core.git`
+1. Add [incubator apex core](https://github.com/apache/incubator-apex-core) as a remote repository (one time step):
+`git remote add upstream https://github.com/apache/incubator-apex-core`
+1. Create a new branch from the [devel-3](https://github.com/apache/incubator-apex-core/tree/devel-3) branch. **Name your branch with the JIRA number in it, e.g. `APEX-123.my-feature`.**
+`git checkout -b APEX-123.my-feature -t upstream/devel-3`
+Creating a local branch that tracks a remote makes pull easier (no need to specify the remote branch while pulling). A branch can be made to track a remote branch anytime, not necessarily at its creation by:
+`git branch -u upstream/devel-3`
1. When adding new files, please include the Apache v2.0 license header.
- From the top level directory, run `mvn license:check -Dlicense.skip=false` to check correct header formatting.
- Run `mvn license:format -Dlicense.skip=false` to automatically add the header when missing.
1. Once your feature is complete, submit the pull request on github against `devel-3`.
1. If you want specific people to review your pull request, use the `@` notation in Github comments to mention that user, and request that he/she reviews your changes.
-1. After all review is complete, combine all new commits into one squashed commit, and include the Jira number in the commit message. There are several ways to squash commits, but [here is one explanation from git-scm.com](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits).
+1. After all review is complete, combine all new commits into one squashed commit, and include the Jira number in the commit message. There are several ways to squash commits, but [here is one explanation from git-scm.com]
+ (https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits) and a simple example is illustrated below:
+
+ If tracking upstream/devel-3 then run `git rebase -i`. Else run `git rebase -i upstream/devel-3`.
+ This command opens the text editor which lists the multiple commits:
+
+ ```
+ pick 67cd79b change1
+ pick 6f98905 change2
+
+ # Rebase e13748b..3463fbf onto e13748b (2 command(s))
+ #
+ # Commands:
+ # p, pick = use commit
+ # r, reword = use commit, but edit the commit message
+ # e, edit = use commit, but stop for amending
+ # s, squash = use commit, but meld into previous commit
+ # f, fixup = like "squash", but discard this commit's log message
+ # x, exec = run command (the rest of the line) using shell
+ #
+ # These lines can be re-ordered; they are executed from top to bottom.
+ ```
+ Squash 'change2' to 'change1' and save.
+
+ ```
+ pick 67cd79b change1
+ squash 6f98905 change2
+ ```
+1. Till the review is complete it may happen that working feature branch may diverge from `devel-3` substantially. Therefore, it is recommended to frequently merge `devel-3` to the branch being worked on by:
+ * when the branch tracks upstream/devel-3
+ `git pull`
+ * when the branch doesn't track upstream
+ `git pull upstream devel-3`
+1. If a pull from `devel-3` results in a conflict then resolve it and commit the merge. This results in additional merge commits in the pull request. Following steps help to ensure that the final pull request contains just one commit:
+ * Rename the original branch:
+ `git branch -m APEX-123.my-feature.squash`
+ * Create a new branch (with the original name) from upstream/devel-3 that has latest changes:
+ `git checkout -b APEX-123.my-feature -t upstream/devel-3`
+ * Squash merge the old branch which was renamed. When the new branch has the latest changes then this squash will result only in the changes that were made for the feature:
+ `git merge --squash APEX-123.my-feature.squash`
+ * Commit the squash and force push it to the old feature remote branch so that the pull request is automatically updated:
+ `git commit -m "APEX-123 #comment added my-feature" `
+ `git push origin +APEX-123.my-feature`
+ * Delete the extra squash branch:
+ `git branch -D APEX-123.my-feature.squash`
Thanks for contributing!
@@ -34,4 +85,4 @@ Thanks for contributing!
seconds, the changes will propagate back to the github mirror and the pull requests be closed and marked merged automatically.
1. The `Fix version` field on the corresponding JIRA ticket needs to be set after pushing the changes.
-**Note: since none of us has write access to the mirror, only the author of a pull request can close it if it was not merged.**
\ No newline at end of file
+**Note: since none of us has write access to the mirror, only the author of a pull request can close it if it was not merged.**
[2/2] incubator-apex-site git commit: Merge branch 'master' of
https://github.com/chandnisingh/incubator-apex-site
Posted by vr...@apache.org.
Merge branch 'master' of https://github.com/chandnisingh/incubator-apex-site
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/c8d5f6fc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/c8d5f6fc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/c8d5f6fc
Branch: refs/heads/master
Commit: c8d5f6fcd8f2b7e0580872a6fd6591627bb7f953
Parents: 7e27886 82c613d
Author: Vlad Rozov <v....@datatorrent.com>
Authored: Thu Nov 12 14:40:34 2015 -0800
Committer: Vlad Rozov <v....@datatorrent.com>
Committed: Thu Nov 12 14:40:34 2015 -0800
----------------------------------------------------------------------
src/md/contributing.md | 59 ++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 55 insertions(+), 4 deletions(-)
----------------------------------------------------------------------