You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GitHub projects support virtually unlimited scale. The upside of this scale is that your projects can grow to include countless files, commits, issues, pull requests, and more. The downside is, well, the same.
2
2
3
-
Suppose you are a developer working on a rapidly growing project. As more contributors come on board, they're able to add features and fix bugs at an incredible rate. However, every one of those changes likely includes a lot of contextual information buried in issues, discussions, commits, and pull requests. While that information seems fresh in everyone's mind at the time, the risk of losing that context as time passes could cost you some significant productivity down the road. What happens when a bug is reported that traces back to work that hasn't been touched for more than a year? Fortunately, GitHub offers a few ways to help you quickly ramp up for any task.
3
+
Suppose you're a developer working on a rapidly growing project. As more contributors come on board, they're able to add features and fix bugs at an incredible rate. However, every one of those changes likely includes a lot of contextual information buried in issues, discussions, commits, and pull requests. While that information seems fresh in everyone's mind at the time, the risk of losing that context as time passes could cost you some significant productivity down the road. What happens when a bug is reported that traces back to work that hasn't been touched for more than a year? Fortunately, GitHub offers a few ways to help you quickly ramp up for any task.
4
4
5
5
In this module, you'll learn how to search and organize repository history by using filters, blame, and cross-linking on GitHub.
6
6
7
7
## Learning objectives
8
8
9
9
In this module, you'll:
10
10
11
-
- Find relevant issues and pull requests
12
-
- Search history to find context
13
-
- Make connections within GitHub to help others find things
11
+
- Find relevant issues and pull requests.
12
+
- Search history to find context.
13
+
- Make connections within GitHub to help others find things.
14
14
15
15
## Prerequisites
16
16
@@ -19,6 +19,6 @@ In this module, you'll:
19
19
20
20
This module covers the process of finding and organizing information on GitHub. To fully appreciate the benefits this module discusses, we recommend that you complete the following modules first:
21
21
22
-
-[Introduction to GitHub](/learn/modules/introduction-to-github)
23
-
-[Manage software delivery by using a release based workflow on GitHub](/learn/modules/release-based-workflow-github)
24
-
-[Manage repository changes by using pull requests on GitHub](/learn/modules/manage-changes-pull-requests-github)
22
+
-[Introduction to GitHub](/training/modules/introduction-to-github)
23
+
-[Manage software delivery by using a release based workflow on GitHub](/training/modules/release-based-workflow-github)
24
+
-[Manage repository changes by using pull requests on GitHub](/training/modules/manage-changes-pull-requests-github)
Copy file name to clipboardExpand all lines: github/search-organize-repository-history-github/includes/2-search-organize-repository-history-github.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,17 @@ As a new team member, you're not yet familiar with the codebase. You also haven'
8
8
9
9
Although you weren't around for the events that led to the sidebar's implementation, many of those events live on in the project's history. Searching the project's repository for "sidebar" will give you a starting point.
10
10
11
-
There are two search methods available on GitHub: the global search at the top of the page, and the scoped search available on certain repository tabs. They support the same syntax and function in the same way, with some key differences.
11
+
There are two search methods available on GitHub: the global search at the top of the page, and the scoped search available on certain repository tabs. They support the same syntax and function in the same way, but with some key differences.
12
12
13
13
### Global search
14
14
15
15
The global search lets you use [the complete search syntax](https://help.github.com/github/searching-for-information-on-github/searching-on-github?azure-portal=true) to search across all of GitHub.
16
16
17
-
17
+
18
18
19
19
The search results are comprehensive and include everything from code to issues to the Marketplace (and even users). This is the best way to find mentions of key terms across multiple result types and repositories.
22
22
23
23
> [!NOTE]
24
24
> The filter clause `is:pr` filters out issues returned from the issues/pull requests store. Some filter clauses, such as `is:pr`, are only supported by certain search providers and ignored by others. For example, the code-search provider doesn't support that clause, so it will ignore it and return the same code results either way.
@@ -31,13 +31,13 @@ To craft a complex global search, try the [advanced search](https://github.com/s
31
31
32
32
Context searches are available on certain tabs, such as **Issues** and **Pull requests**. These searches are scoped into the current repository and only return results of that type. The benefit to this scoping is that it allows the user interface to expose known type-specific filters, such as authors, labels, projects, and more.
33
33
34
-
34
+
35
35
36
36
Using the context search is the preferred option when you're looking for something in the current repository. In our scenario, this would be a good way to find search results mentioning "sidebar," which you could then easily refine using the filter dropdowns.
37
37
38
38
### Using search filters
39
39
40
-
There are an infinite number of ways to search using [the complete search syntax](https://help.github.com/github/searching-for-information-on-github/searching-on-github?azure-portal=true). However, most searches only make use of a few common filters. While these are often available from context search dropdowns, it's sometimes more convenient to type them in directly.
40
+
There are an infinite number of ways to search using [the complete search syntax](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/about-searching-on-github). However, most searches only make use of a few common filters. While these are often available from context search dropdowns, it's sometimes more convenient to type them in directly.
41
41
42
42
Here are some example filter queries:
43
43
@@ -52,7 +52,7 @@ Learn more about [Understanding the search syntax](https://help.github.com/en/gi
52
52
53
53
## What is git blame?
54
54
55
-
Despite its ominous name, `git blame` is a command that displays the commit history for a file. It makes it easy for you to see who made what changes and when. This makes it a lot easier to track down other people who have worked on a file in order to seek out their input or participation.
55
+
Despite its ominous name, `git blame` is a command that displays the commit history for a file. It makes it easy for you to see who made what changes and when. This makes it much easier to track down other people who have worked on a file in order to seek out their input or participation.
56
56
57
57
> [!NOTE]
58
58
> Some Git systems alias `git praise` onto `git blame` to avoid the implication of judgment.
@@ -61,9 +61,9 @@ Despite its ominous name, `git blame` is a command that displays the commit hist
61
61
62
62
GitHub extends the basic `git blame` functionality with a more robust user interface.
63
63
64
-
64
+
65
65
66
-
In our scenario, there are a few ways you might get to this view. You might have found some sidebar code from the global search and selected the **Blame** option to see who worked on it last. Or maybe you found a pull request and tracked that back to the last commit that seems related to the bug description. However you got here, the blame view is an effective way to locate a subject matter expert for the task at hand.
66
+
In our scenario, there are a few ways you might get to this view. You might've found some sidebar code from the global search and selected the **Blame** option to see who worked on it last. Or maybe you found a pull request and tracked that back to the last commit that seems related to the bug description. However you got here, the blame view is an effective way to locate a subject matter expert for the task at hand.
67
67
68
68
## Cross-linking issues, commits, and more
69
69
@@ -73,11 +73,11 @@ Part of what makes GitHub great for collaborative software projects is its suppo
73
73
74
74
To make it even easier to cross-link different items throughout your project, GitHub offers a shorthand syntax. For example, if you leave a comment like `Duplicate of #8`, GitHub will recognize that #8 is an issue and create the appropriate link for you.
81
81
82
82
In our scenario, these links could prove very valuable for ramping up if someone thought ahead to leave the context. For example, the current state of the sidebar may have had some known issues related to a JavaScript dependency. If the issue with that dependency was discussed in another issue that didn't explicitly mention "sidebar", then it would be difficult to find. However, if someone had thought ahead to link the issue in the discussion, then it could save you a lot of time now. Keep that in mind the next time you're documenting issues and pull requests.
83
83
@@ -87,4 +87,4 @@ Learn more about [Autolinked references and URLs](https://help.github.com/en/git
87
87
88
88
Besides linking issues and commits, it's often helpful to associate other people with discussions. The easiest way to do this is by using an `@mention`. This kind of mention notifies the mentioned user so that they can participate in the discussion. It's also a good way to identify people associated with issues long after they have been closed.
89
89
90
-
90
+
Copy file name to clipboardExpand all lines: github/search-organize-repository-history-github/includes/3-connect-dots.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,9 @@ This exercise checks your knowledge on the ability to search and organize your r
2
2
3
3
## Getting started
4
4
5
-
When you click the _Start the exercise on GitHub_ button below, you'll be navigated to a public GitHub template repository that will prompt you to complete a series of small challenges. Before you can begin the exercise, complete the below tasks:
5
+
When you select the **Start the exercise on GitHub** button below, you'll be directed to a public GitHub template repository that will prompt you to complete a series of small challenges. Before you can begin the exercise, complete the below tasks:
6
6
7
-
- Select the _Start course_ button or the _Use this template_ feature within the template repository. This will prompt you to create a new repository. We recommend creating a public repository, as private repositories will use Actions minutes.
8
-
After you make your own repository from the template, wait about 20 seconds and refresh.
7
+
- Select the **Start course** button or the **Use this template** feature within the template repository. This will prompt you to create a new repository. We recommend creating a public repository, as private repositories will use Actions minutes. After you make your own repository from the template, wait about 20 seconds and refresh.
9
8
10
9
- Follow the instructions in the repository's README to understand how the exercise works, its learning objectives, and how to successfully complete the exercise.
11
10
@@ -17,9 +16,8 @@ When you've finished the exercise in GitHub, return here for:
17
16
> * To earn a badge for completing this module
18
17
19
18
>[!Note]
20
-
> You do not need to modify any of the workflow files to complete this exercise.
21
-
> **Altering the contents in this workflow can break the exercise's**
22
-
> **ability to validate your actions, provide feedback, or grade the results**.
19
+
> You do not need to modify any of the workflow files to complete this exercise.
20
+
> **Altering the contents in this workflow can break the exercise's ability to validate your actions, provide feedback, or grade the results**.
23
21
24
22
> [!div class="nextstepaction"]
25
23
> [Start the exercise on GitHub](https://github.com/skills/connect-the-dots?azure-portal=true)
Copy file name to clipboardExpand all lines: github/search-organize-repository-history-github/includes/5-summary.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ You learned about:
6
6
- Searching history to find context
7
7
- Making connections within GitHub to help others find things
8
8
9
-
Now that you're familiar with finding and organizing information on GitHub, learn to [Maintain a secure repository by using GitHub best practices](/learn/modules/maintain-secure-repository-github/).
9
+
Now that you're familiar with finding and organizing information on GitHub, learn to [Maintain a secure repository by using GitHub best practices](/training/modules/maintain-secure-repository-github/).
10
10
11
11
## Learn more
12
12
13
13
Here are some links to more information on the topics we discussed in this module.
14
14
15
-
-[Searching on GitHub](https://help.github.com/github/searching-for-information-on-github/searching-on-github?azure-portal=true)
15
+
-[Searching on GitHub](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/about-searching-on-github)
16
16
-[Understanding the search syntax](https://help.github.com/github/searching-for-information-on-github/understanding-the-search-syntax?azure-portal=true)
-[Tracking changes in a file](https://help.github.com/github/managing-files-in-a-repository/tracking-changes-in-a-file?azure-portal=true)
19
-
-[Autolinked references and URLs](https://help.github.com/github/writing-on-github/autolinked-references-and-urls?azure-portal=true)
18
+
-[View files and track file changes](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file)
19
+
-[Autolinked references and URLs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls)
0 commit comments