diff --git a/config.yml b/config.yml index 1b0f899..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' @@ -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 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 diff --git a/responses/00_welcome-issue.md b/responses/00_welcome-issue.md index 7e6828e..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 @@ -18,7 +20,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
diff --git a/responses/01_crosslink.md b/responses/01_crosslink.md index fabe56c..894635c 100644 --- a/responses/01_crosslink.md +++ b/responses/01_crosslink.md @@ -6,18 +6,18 @@ 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 -## :keyboard: Activity: Find and link to a related issue +### :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..120d694 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? @@ -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 diff --git a/responses/03_context.md b/responses/03_context.md index 79ce3db..721ddf5 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 @@ -33,5 +33,5 @@ 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 + - _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 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