Skip to content

Commit 8e70928

Browse files
author
Randy Pagels
committed
Update documentation to include additional search and organization features in repository history. Add quiz questions and enhance documentation on milestones, labels, saved replies, and assignees.
1 parent 19dd425 commit 8e70928

File tree

3 files changed

+155
-2
lines changed

3 files changed

+155
-2
lines changed

learn-pr/github/search-organize-repository-history-github/4-knowledge-check.yml

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,48 @@ quiz:
4646
explanation: "This linking is a good practice, assuming the author is available to support the issue."
4747
- content: "Add a comment to the bug report that links the pull request to it using the #ID syntax."
4848
isCorrect: false
49-
explanation: "This linking is a good practice as it provides transparency to the issue author and anyone who might end up working on it."
49+
explanation: "This linking is a good practice as it provides transparency to the issue author and anyone who might end up working on it."
50+
- content: "What is a benefit of assigning a milestone to issues or pull requests?"
51+
choices:
52+
- content: "It prevents other users from editing the issue or PR."
53+
isCorrect: false
54+
explanation: "Milestones are used for grouping, not for permissions."
55+
- content: "It helps track progress toward a shared goal, such as a release."
56+
isCorrect: true
57+
explanation: "Milestones group issues/PRs to track completion toward goals."
58+
- content: "It sends email notifications to the entire repository."
59+
isCorrect: false
60+
explanation: "Milestones don't change notification behavior."
61+
- content: "Which query shows all open issues labeled as bugs in a specific milestone?"
62+
choices:
63+
- content: "is:open is:issue label:bug milestone:\"Sprint 1\""
64+
isCorrect: true
65+
explanation: "This query filters by both label and milestone."
66+
- content: "label:bug milestone:closed"
67+
isCorrect: false
68+
explanation: "This query is invalid; milestone:closed is not a valid value."
69+
- content: "is:pr label:bug"
70+
isCorrect: false
71+
explanation: "This filters pull requests, not issues."
72+
- content: "How do you insert a saved reply in an issue or pull request comment?"
73+
choices:
74+
- content: "Click the saved reply icon in the comment field and select from your saved replies."
75+
isCorrect: true
76+
explanation: "The saved reply icon (speech bubble) lets you select from predefined replies."
77+
- content: "Type `@saved` and select from the reply dropdown."
78+
isCorrect: false
79+
explanation: "There is no `@saved` shortcut for replies."
80+
- content: "Use the slash command `/reply` to open your saved replies."
81+
isCorrect: false
82+
explanation: "GitHub does not support slash commands for saved replies."
83+
- content: "What does assigning someone to an issue or pull request indicate?"
84+
choices:
85+
- content: "That the person is responsible for working on it."
86+
isCorrect: true
87+
explanation: "Assigning a user shows they're expected to take ownership."
88+
- content: "That the person is the original author."
89+
isCorrect: false
90+
explanation: "Authorship and assignment are separate."
91+
- content: "That the person will automatically receive a badge."
92+
isCorrect: false
93+
explanation: "GitHub doesn't award badges for assignments."

learn-pr/github/search-organize-repository-history-github/includes/2-search-organize-repository-history-github.md

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Here, we'll discuss how you can use filters, blame, and cross-linking to search and organize repository history.
1+
Here, we'll discuss how you can use filters, blame, cross-linking, labels, milestones, saved replies, and assignees to search and organize repository history.
22

33
Put yourself in the position of a developer who has just joined a large project. Someone just posted a new issue reporting a bug related to the web app's sidebar, and you've been assigned to fix it. You've already read through the report a few times and understand the problem being described, so now you need to figure out how to get started with the fix.
44

@@ -50,6 +50,68 @@ Query|Explanation
5050

5151
Learn more about [Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax?azure-portal=true)
5252

53+
## Using Milestones
54+
55+
Milestones let you group issues and pull requests into shared goals, like a sprint, a product release, or a project phase.
56+
57+
### Create a milestone
58+
59+
1. Navigate to the Issues tab of your repository.
60+
2. Select Milestones from the top menu.
61+
3. Click New milestone.
62+
4. Enter a title, description, and optionally a due date.
63+
5. Click Create milestone.
64+
65+
### Assign a milestone to an issue or pull request
66+
67+
1. Open any issue or PR.
68+
2. In the right sidebar, select Milestone.
69+
3. Choose from the list of available milestones.
70+
71+
When you view a milestone, GitHub shows how many issues/PRs are complete and how many remain—making it a helpful planning and tracking tool.
72+
73+
> You can filter by milestone in GitHub Projects or with advanced search queries like:
74+
>
75+
> ```
76+
> is:open is:pr milestone:"Release v1.0"
77+
> ```
78+
79+
Milestones work best when used consistently across your team's planning workflow.
80+
81+
## Labels and Milestones in Search
82+
83+
Labels and milestones are metadata tools that help teams organize issues and pull requests. They also improve the accuracy of search queries.
84+
85+
### Filter by label
86+
87+
You can narrow down issues by filtering with the `label:` keyword.
88+
89+
For example:
90+
91+
```
92+
is:open is:issue label:bug
93+
```
94+
95+
This returns all open issues labeled as "bug." Labels can reflect issue type, priority, team, or workflow status.
96+
97+
> Tip: You can combine labels with other filters for precise queries, such as:
98+
>
99+
> ```
100+
> is:pr label:"ready for review" author:@me
101+
> ```
102+
103+
### Filter by milestone
104+
105+
Milestones help you group issues and pull requests toward a target release or goal. Use the `milestone:` keyword in your query to return items within a specific milestone.
106+
107+
For example:
108+
109+
```
110+
is:open is:issue milestone:"Sprint 1"
111+
```
112+
113+
> Note: Only open milestones will match unless you include closed ones by searching with `milestone:*`.
114+
53115
## What is git blame?
54116
55117
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.
@@ -69,6 +131,50 @@ In our scenario, there are a few ways you might get to this view. You might've f
69131
70132
Part of what makes GitHub great for collaborative software projects is its support for linking disparate pieces of information together. Some of this happens automatically, such as when you create a pull request from a series of commits on a branch. Other times, you can use the interface to manually link pull requests or projects to issues using the dropdown options.
71133
134+
## Saved replies
135+
136+
Saved replies let you quickly respond to issues and pull requests with prewritten messages. They’re especially helpful for project maintainers who often give the same feedback or instructions.
137+
138+
### Create or edit a saved reply
139+
140+
1. Click your profile photo in the top right corner and select Settings.
141+
2. In the left sidebar, click Saved replies.
142+
3. Select New saved reply.
143+
4. Enter a title and your message.
144+
5. Click Save reply.
145+
146+
To edit or delete a saved reply, return to the Saved replies settings and use the options beside each one.
147+
148+
## Using a saved reply
149+
150+
When writing a comment on an issue or pull request, you can insert a saved reply:
151+
152+
1. Click the comment box.
153+
2. Select the Insert a saved reply icon (speech bubble with lines).
154+
3. Choose a saved reply from the list.
155+
4. Modify the text if needed, then click Comment.
156+
157+
Saved replies save time and help ensure consistency when responding across your project.
158+
159+
## Adding assignees
160+
161+
You can assign one or more people to an issue or pull request to show who’s responsible for working on it.
162+
163+
### Add an assignee
164+
165+
1. Open the issue or pull request.
166+
2. In the right sidebar, click Assignees.
167+
3. Select one or more users from the dropdown.
168+
169+
You can also assign people directly from the list view using the checkboxes beside each issue and selecting Assign from the top bar.
170+
171+
> Tip: Use the `assignee:` filter in your searches to find items assigned to yourself or others.
172+
173+
Example:
174+
```
175+
is:open is:issue assignee:@me
176+
```
177+
72178
### Autolinked references
73179
74180
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.

learn-pr/github/search-organize-repository-history-github/includes/5-summary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ You learned about:
55
- Finding relevant issues and pull requests.
66
- Searching history to find context.
77
- Making connections within GitHub to help others find things.
8+
- Use labels and milestones to filter and organize issues.
9+
- Respond faster with saved replies.
10+
- Assign issues and pull requests to collaborators.
811

912
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/).
1013

0 commit comments

Comments
 (0)