[
https://issues.apache.org/jira/browse/BEAM-3575?focusedWorklogId=80298&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-80298
]
ASF GitHub Bot logged work on BEAM-3575:
----------------------------------------
Author: ASF GitHub Bot
Created on: 14/Mar/18 11:28
Start Date: 14/Mar/18 11:28
Worklog Time Spent: 10m
Work Description: coheigea closed pull request #383: BEAM-3575 - Update
contribution guidelines to add the option of cloni…
URL: https://github.com/apache/beam-site/pull/383
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/src/contribute/contribution-guide.md
b/src/contribute/contribution-guide.md
index 5a7f0b9c6..0c81ad315 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -164,7 +164,8 @@ We assume you are using SSH-based authentication with
GitHub. If necessary,
exchange SSH keys with GitHub by following [their
instructions](https://help.github.com/articles/generating-an-ssh-key/).
-Clone Beam’s read-only GitHub mirror.
+There are two options with regards to cloning Apache Beam. The first is to
+clone Beam’s read-only GitHub mirror:
$ git clone https://github.com/apache/beam.git
$ cd beam
@@ -174,6 +175,17 @@ changes.
$ git remote add <GitHub_user> g...@github.com:<GitHub_user>/beam.git
+The second option is to go to https://github.com/apache/beam and to click on
+the "Fork" button to fork your own copy of apache/beam to your account. Then
+clone this fork as follows:
+
+ $ git clone g...@github.com:<GitHub_user>/beam.git
+ $ cd beam
+
+Then add Beam's GitHub mirror as an additional Git remote:
+
+ $ git remote add upstream g...@github.com:apache/beam.git
+
You are now ready to start developing!
#### [Python SDK Only] Set up a virtual environemt
@@ -210,6 +222,10 @@ branch.
$ git pull --rebase
+Or if you have cloned Apache Beam from a fork in your github account:
+
+ $ git pull upstream master --rebase
+
Remember to always use `--rebase` parameter to avoid extraneous merge commits.
Then you can push your local, committed changes to your (forked) repository on
@@ -218,6 +234,10 @@ push. You'll run:
$ git push <GitHub_user> <my-branch> --force
+Or if you have cloned Apache Beam from a fork in your github account:
+
+ $ git push origin <my-branch> --force
+
### Testing
All code should have appropriate unit testing coverage. New code should have
diff --git a/src/contribute/website-contributions.md
b/src/contribute/website-contributions.md
index dc3c56f42..f26d9eab3 100644
--- a/src/contribute/website-contributions.md
+++ b/src/contribute/website-contributions.md
@@ -26,7 +26,9 @@ in the website repository has more information on how to set
up the required
dependencies for your development environment.
The general guidelines for cloning a repository can be adjusted to use the
-`asf-site` branch of `beam-site`:
+`asf-site` branch of `beam-site`. There are two options with regards to
+cloning the website repository. The first is to clone the read-only GitHub
+mirror:
$ git clone -b asf-site https://github.com/apache/beam-site.git
$ cd beam-site
@@ -34,6 +36,16 @@ The general guidelines for cloning a repository can be
adjusted to use the
$ git fetch --all
$ git checkout -b <my-branch> origin/asf-site
+The second option is to go to https://github.com/apache/beam-site and to click
+on the "Fork" button to fork your own copy of apache/beam-site to your
+account. Then clone this fork as follows:
+
+ $ git clone -b asf-site g...@github.com:<GitHub_user>/beam-site.git
+ $ cd beam-site
+ $ git remote add upstream g...@github.com:apache/beam-site.git
+ $ git fetch --all
+ $ git checkout -b <my-branch> origin/asf-site
+
## Working on your change
While you are working on your pull request, you can test and develop live by
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 80298)
Time Spent: 20m (was: 10m)
> Update contribution guidelines to add the option of cloning from a fork
> -----------------------------------------------------------------------
>
> Key: BEAM-3575
> URL: https://issues.apache.org/jira/browse/BEAM-3575
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Colm O hEigeartaigh
> Assignee: Colm O hEigeartaigh
> Priority: Major
> Time Spent: 20m
> Remaining Estimate: 0h
>
> The contribution guidelines currently show how to clone Beam from the GitHub
> read-only mirror and then to add the user's own GitHub repo as a remote.
> However, it's also possible (and common) to fork the repo manually and then
> to clone the forked repository and work with the original repo as a remote.
> We should update the contribution guidelines to show this as an alternative.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
