RFR: Section on cloning [v8]

David Holmes dholmes at openjdk.java.net
Sun Aug 22 22:34:32 UTC 2021


On Fri, 20 Aug 2021 00:26:55 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> Added a section on cloning from GitHub, and an example of building on Mac. Also fixed two minor bugs that caused problems with syntax highlighting in Atom.
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Introduced SSH earlier

Hi Jesper,

A couple of minor nits but otherwise seems a reasonable balance of information to get someone started.

Thanks,
David

src/index.md line 1001:

> 999:     $ git clone https://github.com/openjdk/jdk.git
> 1000: 
> 1001: If you intend to contribute patches to the JDK, you should first *fork* the JDK repository on GitHub and clone your own fork as shown below. To fork a project on GitHub, go to the [project page](https://github.com/openjdk/jdk) and click the 'Fork' button in the upper right corner, then follow the on screen instructions.

s/own fork/own personal fork/

This introduces the "personal fork" terminology.

src/index.md line 1003:

> 1001: If you intend to contribute patches to the JDK, you should first *fork* the JDK repository on GitHub and clone your own fork as shown below. To fork a project on GitHub, go to the [project page](https://github.com/openjdk/jdk) and click the 'Fork' button in the upper right corner, then follow the on screen instructions.
> 1002: 
> 1003: All pushes to [openjdk/jdk](https://github.com/openjdk/jdk) require an SSH key which must be installed on GitHub. If this is the first time you clone your personal fork of the [openjdk/jdk](https://github.com/openjdk/jdk) repository you may want to create an SSH key to use with it. See [Generating an SSH key] below. Once you have your private fork and an SSH key to go with it, go ahead and clone.

s/private fork/personal fork/

src/index.md line 1009:

> 1007:     $ git remote add upstream https://github.com/openjdk/jdk.git
> 1008: 
> 1009: In the example above Duke cloned his personal fork of the JDK mainline repository using SSH. You should of course use your own GitHub username instead. Then, by adding a new *remote* named 'upstream', the clone is associated with [openjdk/jdk](https://github.com/openjdk/jdk). Doing this will allow the tooling to automatically create a PR on [openjdk/jdk](https://github.com/openjdk/jdk) whenever a change is pushed to the personal fork. The way that works is that once the change has been pushed to the private fork, and you navigate to the [openjdk/jdk](https://github.com/openjdk/jdk) repository on GitHub, there will be a message saying that you just pushed a change and asking if you want to create a PR.

s/private fork/personal fork/

-------------

Marked as reviewed by dholmes (Author).

PR: https://git.openjdk.java.net/guide/pull/59


More information about the guide-dev mailing list