From a2fa9e4537f6858d1bf49ef13ff1c54bbe2ce86b Mon Sep 17 00:00:00 2001 From: Abner Bogan Date: Fri, 24 May 2024 16:17:16 -0400 Subject: [PATCH 1/3] Update course_guide_learners_static.md Modified content on repo cloning; added snapshot of command prompt with annotations and added references in text. --- course_guide_learners_static.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/course_guide_learners_static.md b/course_guide_learners_static.md index 5e1fde4..340b583 100644 --- a/course_guide_learners_static.md +++ b/course_guide_learners_static.md @@ -44,7 +44,27 @@ Congratulations! You've made your own copy of the main repository. Now on to the

Create a local copy (clone)

 -INSERT ISSUE 3! +The next step in our workflow is to clone your fork. This creates a local copy of the repository that is specific to your user on GitHub. The local copy is where you will make changes to the codebase. + +---- +**Action:** Clone this repo! + +![image](https://github.com/CUAHSI/learning-gitflows-template/assets/28936967/53cd6b35-03ec-45d5-bd64-8b889162efd9) + +1. Open the GitHub page for your fork, e.g. `https://github.com/[username]/learning-gitflows-[username]`. *A navigation note*: from your fork, you can easily navigate back to the canonical repository by clicking the link next to "forked from" at the top, just below your forked repository name. From the canonical repo page, you can get back to your fork by clicking the fork button on the canonical repo and choosing your existing fork from the list. +2. Click the green `Code` button that has a drop down arrow. Again, make sure you are ***on your fork***. This means that you see `[username]/learning-gitflows-[username]` at the top of the page with `forked from [org]/learning-gitflows-[username]` underneath. +3. Copy the SSH address, not the HTTPS one (see image below). We should have already set up your SSH keys, but if not, follow [these instructions to generate an SSH key](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and [these instructions to add the SSH key to your GitHub account](https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account). When you come back to the page, you should have the SSH option. + +![image](https://github.com/CUAHSI/learning-gitflows-template/assets/13220910/03273273-ebc7-4d7f-955c-dfaedf68edaa) + +4. Open the command line (Windows --> Command Prompt, Mac or Linux --> Terminal). Note that 'Git Bash' is also used to refer to the command line. +5. Change the working directory ([use `cd`](https://stackoverflow.com/questions/17753986/how-to-change-directory-using-windows-command-line)) to the location where you would like to create the cloned directory (see step 1 in snapshot of command prompt). I would recommend creating a folder somewhere in your D drive to put GitHub projects. +6. Type `git clone [insert URL]` and hit enter (step 2 in snapshot of command prompt), e.g. `git clone git@github.com:[username]/learning-gitflows-[username].git`. Note that you cannot CTRL+V to paste into Git Bash. Right click and choose paste instead. +7. A new folder with the same name as the repository is now available in your working directory. In the folder, you will find the same files and file structure that you can see on GitHub (step 3 and 4 in snapshot of command prompt; use the command `dir` to inspect the folder contents). +8. While in the folder, run the command 'git config pull.rebase false'. This will keep a confusing error message from arising later on. + +You have now successfully cloned your fork! Close this issue and move on to the next one. +
From 0c23f79d438dd897fc001586f732827f6ae88175 Mon Sep 17 00:00:00 2001 From: Abner Bogan Date: Fri, 24 May 2024 16:25:56 -0400 Subject: [PATCH 2/3] Update issue_03.md Modified content on repo cloning; added snapshot of command prompt with annotations and added references in text. --- .github/issues_to_create/issue_03.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/issues_to_create/issue_03.md b/.github/issues_to_create/issue_03.md index 393bd8d..4320faf 100644 --- a/.github/issues_to_create/issue_03.md +++ b/.github/issues_to_create/issue_03.md @@ -3,16 +3,18 @@ The next step in our workflow is to clone your fork. This creates a local copy o ---- **Action:** Clone this repo! +![image](https://github.com/CUAHSI/learning-gitflows-template/assets/28936967/53cd6b35-03ec-45d5-bd64-8b889162efd9) + 1. Open the GitHub page for your fork, e.g. `https://github.com/[username]/learning-gitflows-[username]`. *A navigation note*: from your fork, you can easily navigate back to the canonical repository by clicking the link next to "forked from" at the top, just below your forked repository name. From the canonical repo page, you can get back to your fork by clicking the fork button on the canonical repo and choosing your existing fork from the list. 2. Click the green `Code` button that has a drop down arrow. Again, make sure you are ***on your fork***. This means that you see `[username]/learning-gitflows-[username]` at the top of the page with `forked from [org]/learning-gitflows-[username]` underneath. 3. Copy the SSH address, not the HTTPS one (see image below). We should have already set up your SSH keys, but if not, follow [these instructions to generate an SSH key](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and [these instructions to add the SSH key to your GitHub account](https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account). When you come back to the page, you should have the SSH option. ![image](https://github.com/CUAHSI/learning-gitflows-template/assets/13220910/03273273-ebc7-4d7f-955c-dfaedf68edaa) -4. Open Git Bash on your computer. -5. Change the working directory ([use `cd`](https://stackoverflow.com/questions/17753986/how-to-change-directory-using-windows-command-line)) to the location where you would like to create the cloned directory. I would recommend creating a folder somewhere in your D drive to put GitHub projects. -6. Type `git clone [insert URL]` and hit enter, e.g. `git clone git@github.com:[username]/learning-gitflows-[username].git`. Note that you cannot CTRL+V to paste into Git Bash. Right click and choose paste instead. -7. A new folder with the same name as the repository is now available in your working directory. In the folder, you will find the same files and file structure that you can see on GitHub. +4. Open the command line (Windows --> Command Prompt, Mac or Linux --> Terminal). Note that 'Git Bash' is also used to refer to the command line. +5. Change the working directory ([use `cd`](https://stackoverflow.com/questions/17753986/how-to-change-directory-using-windows-command-line)) to the location where you would like to create the cloned directory (see step 1 in snapshot of command prompt). I would recommend creating a folder somewhere in your D drive to put GitHub projects. +6. Type `git clone [insert URL]` and hit enter (step 2 in snapshot of command prompt), e.g. `git clone git@github.com:[username]/learning-gitflows-[username].git`. Note that you cannot CTRL+V to paste into Git Bash. Right click and choose paste instead. +7. A new folder with the same name as the repository is now available in your working directory. In the folder, you will find the same files and file structure that you can see on GitHub (step 3 and 4 in snapshot of command prompt; use the command `dir` to inspect the folder contents). 8. While in the folder, run the command 'git config pull.rebase false'. This will keep a confusing error message from arising later on. You have now successfully cloned your fork! Close this issue and move on to the next one. From 947c47475bed84f5f740ecc2ebc4be89828b2a5a Mon Sep 17 00:00:00 2001 From: Abner Bogan Date: Fri, 24 May 2024 16:30:33 -0400 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Lindsay (Carr) Platt --- .github/issues_to_create/issue_03.md | 2 +- course_guide_learners_static.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/issues_to_create/issue_03.md b/.github/issues_to_create/issue_03.md index 4320faf..7f765ca 100644 --- a/.github/issues_to_create/issue_03.md +++ b/.github/issues_to_create/issue_03.md @@ -11,7 +11,7 @@ The next step in our workflow is to clone your fork. This creates a local copy o ![image](https://github.com/CUAHSI/learning-gitflows-template/assets/13220910/03273273-ebc7-4d7f-955c-dfaedf68edaa) -4. Open the command line (Windows --> Command Prompt, Mac or Linux --> Terminal). Note that 'Git Bash' is also used to refer to the command line. +4. Open the command line (Windows --> Command Prompt, Mac or Linux --> Terminal). Note that 'Git Bash' is also used to refer to the command line in this training. 5. Change the working directory ([use `cd`](https://stackoverflow.com/questions/17753986/how-to-change-directory-using-windows-command-line)) to the location where you would like to create the cloned directory (see step 1 in snapshot of command prompt). I would recommend creating a folder somewhere in your D drive to put GitHub projects. 6. Type `git clone [insert URL]` and hit enter (step 2 in snapshot of command prompt), e.g. `git clone git@github.com:[username]/learning-gitflows-[username].git`. Note that you cannot CTRL+V to paste into Git Bash. Right click and choose paste instead. 7. A new folder with the same name as the repository is now available in your working directory. In the folder, you will find the same files and file structure that you can see on GitHub (step 3 and 4 in snapshot of command prompt; use the command `dir` to inspect the folder contents). diff --git a/course_guide_learners_static.md b/course_guide_learners_static.md index 340b583..36be3a5 100644 --- a/course_guide_learners_static.md +++ b/course_guide_learners_static.md @@ -57,7 +57,7 @@ The next step in our workflow is to clone your fork. This creates a local copy o ![image](https://github.com/CUAHSI/learning-gitflows-template/assets/13220910/03273273-ebc7-4d7f-955c-dfaedf68edaa) -4. Open the command line (Windows --> Command Prompt, Mac or Linux --> Terminal). Note that 'Git Bash' is also used to refer to the command line. +4. Open the command line (Windows --> Command Prompt, Mac or Linux --> Terminal). Note that 'Git Bash' is also used to refer to the command line in this training. 5. Change the working directory ([use `cd`](https://stackoverflow.com/questions/17753986/how-to-change-directory-using-windows-command-line)) to the location where you would like to create the cloned directory (see step 1 in snapshot of command prompt). I would recommend creating a folder somewhere in your D drive to put GitHub projects. 6. Type `git clone [insert URL]` and hit enter (step 2 in snapshot of command prompt), e.g. `git clone git@github.com:[username]/learning-gitflows-[username].git`. Note that you cannot CTRL+V to paste into Git Bash. Right click and choose paste instead. 7. A new folder with the same name as the repository is now available in your working directory. In the folder, you will find the same files and file structure that you can see on GitHub (step 3 and 4 in snapshot of command prompt; use the command `dir` to inspect the folder contents).