@@ -54,8 +54,7 @@ to fix and build on top of the existing code during the course.
5454
5555## Downloading Our Software Project
5656
57- To start working on the project, you will first
58- create a copy of the software project template repository
57+ To start working on the project, you will first create a fork of the software project repository
5958from GitHub within your own GitHub account
6059and then obtain a local copy of that project (from your GitHub) on your machine.
6160
@@ -65,41 +64,45 @@ and then obtain a local copy of that project (from your GitHub) on your machine.
6564 Note that, while it is possible to use ** HTTPS** with a personal access token for authentication with GitHub,
6665 the recommended and supported authentication method to use for this course is via SSH and key pairs.
67662 . Log into your GitHub account.
68- 3 . Go to the [ software project template repository] ( https://github.com/carpentries-incubator/python-intermediate-inflammation )
67+ 3 . Go to the [ software project repository] ( https://github.com/carpentries-incubator/python-intermediate-inflammation )
6968 in GitHub.
7069
71- ![ Software project template repository in GitHub] ( ../fig/template- repository.png ) {: .image-with-shadow width="800px " }
70+ ![ Software project fork repository in GitHub] ( ../fig/github-fork- repository.png ) {: .image-with-shadow width="900px " }
7271
73- 4 . Click the ` Use this template ` button
74- towards the top right of the template repository's GitHub page to create
75- a ** copy** of the repository under your GitHub account
76- (you will need to be signed into GitHub to see the ` Use this template ` button).
77- Note that each participant is creating their own copy to work on.
78- Also, we are not forking the directory but creating a copy
79- (remember - you can have only one * fork* but can have multiple * copies* of a repository in GitHub).
72+ 4 . Click the ` Fork ` button
73+ towards the top right of the repository's GitHub page to create
74+ a ** fork** of the repository under your GitHub account
75+ (you will need to be signed into GitHub for the ` Fork ` button to work).
76+ Note that each participant is creating their own fork to work on.
77+ Also, we are not copying from a template but creating a fork
78+ (remember you can have only one * fork*
79+ but can have multiple * copies* of a repository in GitHub).
80805 . Make sure to select your personal account
8181 and set the name of the project to ` python-intermediate-inflammation `
8282 (you can call it anything you like,
8383 but it may be easier for future group exercises if everyone uses the same name).
84- Also set the new repository's visibility to 'Public' -
85- so it can be seen by others and by third-party Continuous Integration (CI) services
86- (to be covered later on in the course) .
84+ Ensure that you ** uncheck ** the ` Copy the main branch only ` button.
85+ This will guarantee we get some other branches needed for later exercises,
86+ but for the moment you can ignore them .
8787
88- ![ Making a copy of the software project template repository in GitHub] ( ../fig/copy-template -repository.png ) {: .image-with-shadow width="600px" }
88+ ![ Making a fork of the software project repository in GitHub] ( ../fig/github-fork -repository-confirm .png ) {: .image-with-shadow width="600px" }
8989
90- 6 . Click the ` Create repository from template ` button
91- and wait for GitHub to import the copy of the repository under your account.
92- 7 . Locate the copied repository under your own GitHub account.
90+ 6 . Click the ` Create fork ` button
91+ and wait for GitHub to create the forked copy of the repository under your account.
92+ 7 . Locate the forked repository under your own GitHub account.
93+ You should be taken there automatically after confirming the fork operation,
94+ but if not, you can click your username top left to be taken to your user page,
95+ and then select the ` Repositories ` tab, where you can search for this new fork.
9396
94- ![ View of the own copy of the software template repository in GitHub] ( ../fig/own-template -repository.png ) {: .image-with-shadow width="800px " }
97+ ![ View of your own fork of the software repository in GitHub] ( ../fig/github-forked -repository-own .png ) {: .image-with-shadow width="900px " }
9598
9699> ## Exercise: Obtain the Software Project Locally
97100> Using the command line, clone the copied repository
98101> from your GitHub account into the home directory on your computer using SSH.
99102> Which command(s) would you use to get a detailed list of contents of the directory you have just cloned?
100103> > ## Solution
101104> > 1 . Find the SSH URL of the software project repository to clone from your GitHub account.
102- > > Make sure you do not clone the original template repository but rather your own copy ,
105+ > > Make sure you do not clone the original repository but rather your own fork ,
103106> > as you should be able to push commits to it later on.
104107> > Also make sure you select the ** SSH** tab and not the ** HTTPS** one -
105108> > for this course, SSH is the preferred way of authenticating when sending your changes back to GitHub.
@@ -116,7 +119,7 @@ and then obtain a local copy of that project (from your GitHub) on your machine.
116119> > $ git clone git@github.com:<YOUR_GITHUB_USERNAME>/python-intermediate-inflammation.git
117120> > ~~~
118121> > {: .language-bash}
119- > > Make sure you are cloning your copy of the software project and not the template repository.
122+ > > Make sure you are cloning your fork of the software project and not the original repository.
120123> >
121124> > 4. Navigate into the cloned repository folder in your command line with:
122125> > ~~~
0 commit comments