diff --git a/docs/source/developers/github/forks.rst b/docs/source/developers/github/forks.rst index 2807e4009..f8bc90987 100644 --- a/docs/source/developers/github/forks.rst +++ b/docs/source/developers/github/forks.rst @@ -3,9 +3,9 @@ Fork a repository Forking a repository is taking a copy of a GitHub repository and associating it to your own account space so you can make changes to the code base. Since you own this copy, you will have fetch/push access to the repository. -We will first create a fork on the xcat2/xcat-core project so that we can work on functions without affecting the mainline (or *upstream*) code. Additionally, by creating a fork, you are able to generate *pull request* so that the changes can be easily seen and reviewed by other community members. +We will first create a fork on the xcat2/xcat-core project so that we can work on functions without affecting the mainline (or *upstream*) code. Additionally, by creating a fork, you are able to generate *pull request* so that the changes can be easily seen and reviewed by other community members. -* In GitHub UI, find a project that you want to fork and click on the "Fork" icon. +* In GitHub UI, find a project that you want to fork and click on the "Fork" icon. .. image:: github-fork.png @@ -15,13 +15,13 @@ We will first create a fork on the xcat2/xcat-core project so that we can work o ``/xcat-core`` <-- forked copy - ``xcat2/xcat-core`` <-- upstream + ``xcat2/xcat-core`` <-- upstream Clone the forked repository =========================== -* On your development machine, clone the forked repository from **your** account: +* On your development machine, clone the forked repository from **your** account: **Note:** Ensure the clone is from */xcat-core* and **not** *xcat2/xcat-core* :: @@ -29,7 +29,7 @@ Clone the forked repository This now becomes the origin remote repository: :: - $ git remote -v + $ git remote -v origin git@github.com:/xcat-core.git (fetch) origin git@github.com:/xcat-core.git (push) @@ -43,7 +43,7 @@ Configure an ``upstream`` repository View the configured repositories: :: - $ git remote -v + $ git remote -v origin git@github.com:/xcat-core.git (fetch) origin git@github.com:/xcat-core.git (push) upstream git@github.com:xcat2/xcat-core.git (fetch)