From 9e98b6d75caae9acffacd4c3604f3815f70e6e67 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 13:57:48 +0200 Subject: [PATCH 01/14] update reference to image --- responses/03_context.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/responses/03_context.md b/responses/03_context.md index 79ce3db..ddf31af 100644 --- a/responses/03_context.md +++ b/responses/03_context.md @@ -23,7 +23,7 @@ Just like that, you've found the people at your company who can help move your p When you're looking at a commit on GitHub, you can see a lot of information. From this view, you can also find a link to the pull request in which the commit was created. We'll use this in the next step. -![screenshot of a view of a commit on GitHub, highlighting the link to the pull request](/images/pr-link.png) +![screenshot of a view of a commit on GitHub, highlighting the link to the pull request](https://github.com/githubtraining/working-in-large-repositories/blob/master/responses/images/pr-link.png?raw=true) ## Step 4: Give more context From b7eaa1143443264799ba80d1c733f48fb142073d Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 13:59:16 +0200 Subject: [PATCH 02/14] simplify instructions --- responses/03_context.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/responses/03_context.md b/responses/03_context.md index ddf31af..9a24566 100644 --- a/responses/03_context.md +++ b/responses/03_context.md @@ -33,5 +33,4 @@ In the story above, you might want to `@mention` the authors involved in the art 1. In the tab where you found the commit SHA in the last step, click the link to the related pull request 2. Copy a reference (like a link) to this pull request -3. Comment with a link to the "Add Navigation" pull request in this issue - +3. Reference the pull request in this issue From e355f59053b930dc2a1091d473df9ad1ca1ecd9c Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:00:15 +0200 Subject: [PATCH 03/14] add tip about referencing issues or prs --- responses/03_context.md | 1 + 1 file changed, 1 insertion(+) diff --git a/responses/03_context.md b/responses/03_context.md index 9a24566..d90dab8 100644 --- a/responses/03_context.md +++ b/responses/03_context.md @@ -34,3 +34,4 @@ In the story above, you might want to `@mention` the authors involved in the art 1. In the tab where you found the commit SHA in the last step, click the link to the related pull request 2. Copy a reference (like a link) to this pull request 3. Reference the pull request in this issue + - _Tip: Try typing `#5` and seeing what happens! Do you notice a reference to the `Add Navigation` pull request?_ \ No newline at end of file From c689684b570d2e2ceb31846827f3c3331a75c1b6 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:03:31 +0200 Subject: [PATCH 04/14] clarify instructions --- responses/05_fix-build.md | 6 +++--- responses/06_please-merge.md | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/responses/05_fix-build.md b/responses/05_fix-build.md index dfcf89a..b0b0215 100644 --- a/responses/05_fix-build.md +++ b/responses/05_fix-build.md @@ -8,6 +8,6 @@ People in the future could look for this work and find out lots of things. They ### :keyboard: Activity: Correct the spelling to fix the build -1. [Edit the `docs/git-tips.md` file]({{ repoUrl }}/edit/add-git-tips/docs/git-tips.md) on this `add-git-tips` branch -2. Correct the spelling of the word `trics`, by changing it into `tricks` -3. Commit the changes \ No newline at end of file +1. [Edit the `docs/git-tips.md` file]({{ repoUrl }}/edit/add-git-tips/docs/git-tips.md) +2. Correct the spelling of the word `trics` on line 3 by changing it into `tricks` +3. Commit the changes on the `add-git-tips` branch \ No newline at end of file diff --git a/responses/06_please-merge.md b/responses/06_please-merge.md index be81915..ada4f78 100644 --- a/responses/06_please-merge.md +++ b/responses/06_please-merge.md @@ -1,5 +1,7 @@ ## Step 6: Merge +Great work! By correcting the spelling, your commit triggered another status. You can see this represented by the green check mark next to your commit in the pull request timeline. :tada: + ### :keyboard: Activity: Merge this pull request 1. Merge this pull request From eff21b2bbd77f0191f3a9f6422fd431e59fabdc9 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:07:03 +0200 Subject: [PATCH 05/14] fix last step response --- config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/config.yml b/config.yml index 1b0f899..2ab9f33 100644 --- a/config.yml +++ b/config.yml @@ -148,4 +148,5 @@ steps: title: Congratulations! body: 07_congratulations.md - type: respond - with: 07_final-issue.md \ No newline at end of file + with: 07_final-issue.md + issue: Add Git tips \ No newline at end of file From 6923a300f7eb631e55ff389519b8c0eeb2000545 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:09:36 +0200 Subject: [PATCH 06/14] more descriptive step titles --- config.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/config.yml b/config.yml index 2ab9f33..24214de 100644 --- a/config.yml +++ b/config.yml @@ -51,8 +51,8 @@ before: steps: # Step 1: - - title: Close the linked issue - description: Close the linked issue + - title: References within issues + description: Find and close the duplicate cross-linked issue event: issues.closed link: '{{ repoUrl }}/issues/1' actions: @@ -72,7 +72,7 @@ steps: # Step 2: Crosslink - title: Create a crosslink - description: Find the relevant or duplicate issue or pull request, and create a contexual crosslink + description: Find the relevant or duplicate issue or pull request, and create a crosslink event: issue_comment.created link: '{{ repoUrl }}/issues/7' actions: @@ -85,7 +85,7 @@ steps: # Step 3: - title: Find a commit - description: Find a specific commit (related to content concept of issue in step 2) + description: Find the commit associated with the creation of the sidebar file event: issue_comment.created link: '{{ repoUrl }}/issues/7' actions: @@ -110,8 +110,8 @@ steps: with: 04_find-broken-build.md # Step 5: - - title: Assign yourself to the pr with broken build - description: Assign yourself to the pr with broken build + - title: Assign yourself + description: Assign yourself to the pull request with a broken build event: pull_request.assigned link: '{{ repoUrl }}/issues/7' actions: @@ -120,7 +120,7 @@ steps: # Step 6: Something to do with tests - title: Fix the broken build - description: Fix the broken build + description: Fix the broken build in the pull request with a new commit event: push link: '{{ repoUrl }}/pull/6' actions: @@ -139,7 +139,7 @@ steps: issue: Add Git tips # Step 7: Merge pull request - - title: Merge the pull request + - title: Merge description: Merge the final pull request event: push link: '{{ repoUrl }}/pull/6' From 157481b18e012ec7ff076405ed91d14afc7b27bc Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:11:18 +0200 Subject: [PATCH 07/14] clarify first instructions --- responses/00_welcome-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/responses/00_welcome-issue.md b/responses/00_welcome-issue.md index 7e6828e..98e87c8 100644 --- a/responses/00_welcome-issue.md +++ b/responses/00_welcome-issue.md @@ -18,7 +18,7 @@ Below, you will see a reference to another issue. The other issue references _th ### :keyboard: Activity: Find and close the cross-linked issue -1. Find the other issue referenced from this issue +1. Navigate to the other issue referenced from this issue 2. Close that issue
From b7ecee728f4667d7086496721ae66fb06e5925bc Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:12:30 +0200 Subject: [PATCH 08/14] recommend users do intro course first --- responses/00_welcome-issue.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/responses/00_welcome-issue.md b/responses/00_welcome-issue.md index 98e87c8..1d866b3 100644 --- a/responses/00_welcome-issue.md +++ b/responses/00_welcome-issue.md @@ -2,6 +2,8 @@ Welcome to this Learning Lab course about working in large repositories. For example, you could be working in repositories with a lot of history. Or, working with many collaborators. No matter how your repository is "large", it's important to know how to navigate your workspace. +Before you take this course, you may want to go through the [Introduction to GitHub](https://lab.github.com/githubtraining/introduction-to-github) course on Learning Lab. + In this course, you'll learn how to do lots of things, like: - Find relevant issues and pull requests From 7792d63064f3a20ac688d0ead8625003192107ee Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:13:56 +0200 Subject: [PATCH 09/14] make sure links have descriptive titles --- responses/01_crosslink.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/responses/01_crosslink.md b/responses/01_crosslink.md index fabe56c..0434cbb 100644 --- a/responses/01_crosslink.md +++ b/responses/01_crosslink.md @@ -6,13 +6,13 @@ Next, we'll practice finding issues and creating crosslinks to improve discovera ### Finding issues and pull requests -You can search for issues and pull requests in many ways, like by author, title, or even the most recently updated. You can also search closed issues. You can read all about the different ways to search in the [GitHub Help documentation](https://help.github.com/en/articles/searching-issues-and-pull-requests#search-by-open-or-closed-state). +You can search for issues and pull requests in many ways, like by author, title, or even the most recently updated. You can also search closed issues. You can read all about the different ways to search in the [Searching Issues or Pull Requests](https://help.github.com/en/articles/searching-issues-and-pull-requests#search-by-open-or-closed-state) article. ### Creating references When you link to another issue, a reference within GitHub is automatically created. In fact, you don't even need to include the full link. If you were to type `#5` within a comment, that would turn into a link to issue or pull request number 5. -When you want to create a crosslink, try typing the title of an issue or pull request directly after you type the `#` symbol. GitHub will suggest issues or pull requests that will link to the right place. To learn even more, check out [GitHub's documentation](https://help.github.com/en/articles/autolinked-references-and-urls). +When you want to create a crosslink, try typing the title of an issue or pull request directly after you type the `#` symbol. GitHub will suggest issues or pull requests that will link to the right place. To learn even more, check out the [Autolinked References and URLs](https://help.github.com/en/articles/autolinked-references-and-urls) article. ## Step 2: Create crosslinks @@ -20,4 +20,3 @@ When you want to create a crosslink, try typing the title of an issue or pull re 1. Please find the related issue 2. Comment in this issue with a reference to the related issue with a short description - From 26c7083d24c0e2715fe10042023d72dd177ba1ba Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:15:25 +0200 Subject: [PATCH 10/14] clarify instructions --- responses/01_crosslink.md | 3 ++- responses/02_find-commit.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/responses/01_crosslink.md b/responses/01_crosslink.md index 0434cbb..6175a85 100644 --- a/responses/01_crosslink.md +++ b/responses/01_crosslink.md @@ -18,5 +18,6 @@ When you want to create a crosslink, try typing the title of an issue or pull re ## :keyboard: Activity: Find and link to a related issue -1. Please find the related issue +1. Please find the issue that is similar to this one + - This does _not_ mean that the issue is referenced, like in the last step - you should go look in the [Issues]({{ repoURL }}/issues) tab to find an issue with a similar title 2. Comment in this issue with a reference to the related issue with a short description diff --git a/responses/02_find-commit.md b/responses/02_find-commit.md index b4b9a3f..18af45b 100644 --- a/responses/02_find-commit.md +++ b/responses/02_find-commit.md @@ -6,7 +6,7 @@ The obvious reason to find things in history is to know about history. With issu ### What's `git blame`? -Git Blame is a Git functionality that shows what revision and author last modified each line of a file. Information like who made a commit, when, and even why can be found this way. If you aren't sure who introduced certain changes to a file, you can use `git blame` to find out. While `git blame` sounds rather accusatory, this can be used to understand the context around decisions. +`git blame` is a Git functionality that shows what revision and author last modified each line of a file. Information like who made a commit, when, and even why can be found this way. If you aren't sure who introduced certain changes to a file, you can use `git blame` to find out. While `git blame` sounds rather accusatory, this can be used to understand the context around decisions. ### What's a SHA? From 6e8fe19e104a21a7b42758e211f046a729763b96 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:16:44 +0200 Subject: [PATCH 11/14] create course landing page content --- course-details.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/course-details.md b/course-details.md index a9b3bff..eb7c182 100644 --- a/course-details.md +++ b/course-details.md @@ -1,9 +1,9 @@ -This is the description we show on the course page [here](https://lab.github.com/githubtraining/working-in-large-repositories). This first paragraph will be featured at the top of the page so make it great. -​ +Welcome to this Learning Lab course about working in large repositories. For example, you could be working in repositories with a lot of history. Or, working with many collaborators. No matter how your repository is "large", it's important to know how to navigate your workspace. -​ -Be sure to tell the learner about the technology you are teaching, why they should learn it, how they can use it, and what you will teach them. -​ +Before you take this course, you may want to go through the [Introduction to GitHub](https://lab.github.com/githubtraining/introduction-to-github) course on Learning Lab. +In this course, you'll learn how to do lots of things, like: -Include information on how they can reach you for questions about the content or course. \ No newline at end of file +- Find relevant issues and pull requests +- Search history to find context +- Make connections within GitHub to help others find things From 8bbebe3c32019944db2e5369461356c64da9734d Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:20:06 +0200 Subject: [PATCH 12/14] consistent headers --- responses/01_crosslink.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/responses/01_crosslink.md b/responses/01_crosslink.md index 6175a85..894635c 100644 --- a/responses/01_crosslink.md +++ b/responses/01_crosslink.md @@ -16,7 +16,7 @@ When you want to create a crosslink, try typing the title of an issue or pull re ## Step 2: Create crosslinks -## :keyboard: Activity: Find and link to a related issue +### :keyboard: Activity: Find and link to a related issue 1. Please find the issue that is similar to this one - This does _not_ mean that the issue is referenced, like in the last step - you should go look in the [Issues]({{ repoURL }}/issues) tab to find an issue with a similar title From 78425c790d16f64852ad577d02561ec180f10f08 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:21:37 +0200 Subject: [PATCH 13/14] correct repoUrl capitalization error --- responses/02_find-commit.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/responses/02_find-commit.md b/responses/02_find-commit.md index 18af45b..120d694 100644 --- a/responses/02_find-commit.md +++ b/responses/02_find-commit.md @@ -16,7 +16,7 @@ A SHA is a reference to a specific object. In this case, it's a reference to a c ### :keyboard: Activity: Find and reference the navigation commit -1. Navigate to the [Code tab of this repository]({{ repoURL }}) +1. Navigate to the [Code tab of this repository]({{ repoUrl }}) - _Tip: start this process in a new tab, since you will need it later_ 2. Click `docs` to navigate into the `/docs` directory 3. Click `_sidebar.md` to view the file From 79b87012b799ac7516366fa195bfeb82d3f1cfc4 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 25 Sep 2019 14:23:50 +0200 Subject: [PATCH 14/14] fix markdown format --- responses/03_context.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/responses/03_context.md b/responses/03_context.md index d90dab8..721ddf5 100644 --- a/responses/03_context.md +++ b/responses/03_context.md @@ -34,4 +34,4 @@ In the story above, you might want to `@mention` the authors involved in the art 1. In the tab where you found the commit SHA in the last step, click the link to the related pull request 2. Copy a reference (like a link) to this pull request 3. Reference the pull request in this issue - - _Tip: Try typing `#5` and seeing what happens! Do you notice a reference to the `Add Navigation` pull request?_ \ No newline at end of file + - _Tip: Try typing `#5` and seeing what happens! Do you notice a reference to the `Add Navigation` pull request?_ \ No newline at end of file