Skip to content

Commit c48a150

Browse files
sophiethekingSiaraMisthubwriter
authored
Builders: Make Copilot discoverable in Core Productivity docs (#53086)
Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com>
1 parent 4d37612 commit c48a150

File tree

12 files changed

+235
-18
lines changed

12 files changed

+235
-18
lines changed
Loading

content/get-started/exploring-projects-on-github/contributing-to-a-project.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ redirect_from:
1818

1919
## About forking
2020

21-
If you want to contribute to someone else's project but don't have write access to the repository, you can use a "fork and pull request" workflow.
21+
If you want to contribute to someone else's project but dont have permission to make changes directly, you can create your own copy of the project, make updates, and then suggest those updates for inclusion in the main project. This process is often called a "fork and pull request" workflow.
2222

23-
{% data reusables.repositories.fork-definition-long %}
23+
When you create your own copy (or "fork") of a project, it’s like making a new workspace that shares code with the original project. This is useful for open-source projects or anytime you don’t have write access to the original project.
2424

25-
You can contribute by submitting pull requests from your fork to the upstream repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)."
25+
Once you’ve made your changes in your copy, you can submit them as a pull request, which is a way to propose changes back to the main project. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)."
2626

27-
## Forking a repository
27+
## Creating your own copy of a project
2828

2929
This tutorial uses [the Spoon-Knife project](https://github.com/octocat/Spoon-Knife), a test repository that's hosted on {% data variables.product.prodname_dotcom %} that lets you test the fork and pull request workflow.
3030

@@ -44,7 +44,7 @@ This tutorial uses [the Spoon-Knife project](https://github.com/octocat/Spoon-Kn
4444
> [!NOTE]
4545
> If you want to copy additional branches from the upstream repository, you can do so from the **Branches** page. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)."
4646
47-
## Cloning a fork
47+
## Cloning a fork to your computer
4848

4949
You've successfully forked the Spoon-Knife repository, but so far, it only exists on {% data variables.product.product_name %}. To be able to work on the project, you will need to clone it to your computer.
5050

@@ -99,7 +99,7 @@ gh repo fork REPOSITORY --clone=true
9999

100100
## Creating a branch to work on
101101

102-
Before making changes to the project, you should create a new branch and check it out. By keeping changes in their own branch, you follow GitHub Flow and ensure that it will be easier to contribute to the same project again in the future. For more information, see "[AUTOTITLE](/get-started/using-github/github-flow#following-github-flow)."
102+
Before making changes to the project, you should create a new branch and check it out. By keeping changes in their own branch, you follow {% data variables.product.github %} flow and ensure that it will be easier to contribute to the same project again in the future. See "[AUTOTITLE](/get-started/using-github/github-flow#following-github-flow)."
103103

104104
{% webui %}
105105

@@ -127,7 +127,7 @@ For more information about how to create and manage branches in {% data variable
127127

128128
## Making and pushing changes
129129

130-
Go ahead and make a few changes to the project using your favorite text editor, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com). You could, for example, change the text in `index.html` to add your GitHub username.
130+
Go ahead and make a few changes to the project using your favorite text editor, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com). You could, for example, change the text in `index.html` to add your {% data variables.product.github %} username.
131131

132132
When you're ready to submit your changes, stage and commit your changes. `git add .` tells Git that you want to include all of your changes in the next commit. `git commit` takes a snapshot of those changes.
133133

@@ -199,3 +199,9 @@ Pull requests are an area for discussion. Don't be offended if the project owner
199199

200200
You've successfully forked and contributed back to a repository. Go forth, and
201201
contribute some more!{% ifversion fpt %} For more information, see "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %}
202+
203+
{% ifversion copilot %}
204+
205+
## Familiarizing yourself with a project
206+
207+
If you're new to a project, you can use {% data variables.product.prodname_copilot_short %} to help you understand the purpose of the repository, examine files, and dive into specific lines of code. See "[AUTOTITLE](/get-started/exploring-projects-on-github/using-github-copilot-to-explore-projects)."{% endif %}

content/get-started/exploring-projects-on-github/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ topics:
1515
- Projects
1616
children:
1717
- /finding-ways-to-contribute-to-open-source-on-github
18+
- /using-github-copilot-to-explore-projects
1819
- /contributing-to-a-project
1920
- /saving-repositories-with-stars
2021
- /following-people
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Using GitHub Copilot to explore projects
3+
intro: 'This guide will help you use {% data variables.product.prodname_copilot_short %} to explore projects on {% data variables.product.prodname_dotcom %}.'
4+
versions:
5+
feature: copilot
6+
topics:
7+
- Copilot
8+
- Repositories
9+
shortTitle: Use Copilot to explore projects
10+
---
11+
12+
> [!NOTE] {% data variables.product.prodname_copilot_chat_dotcom %} is currently in {% data variables.release-phases.public_preview %} and is subject to change.
13+
14+
In this guide, you’ll learn how to use {% data variables.product.prodname_copilot_chat_dotcom_short %} to understand a repository’s purpose, examine files, and dive into specific lines of code. By following these steps, you’ll gain insights into any project faster—making onboarding, code review, and project exploration easier and more efficient.
15+
16+
## Prerequisites
17+
18+
{% data reusables.copilot.copilot-requires-subscription %}
19+
20+
## Understanding a repository
21+
22+
When you’re new to a project, it can be challenging to understand the purpose of a repository and its files. {% data variables.product.prodname_copilot_short %} can help you quickly understand the purpose of a repository, for example, by providing a summary of the repository’s README file.
23+
24+
1. On the {% data variables.product.prodname_dotcom %} website, go to the repository you want to chat about.
25+
26+
1. Click the **{% octicon "copilot" aria-hidden="true" %}** {% data variables.product.prodname_copilot %} icon at the top right of the page.
27+
1. The heading at the top of the chat panel should read "Chatting about" followed by the name of the current repository.
28+
29+
If the wrong repository name is displayed, because you were previously chatting about another repository, click **All repositories** then choose the repository you want to chat about.
30+
31+
![Screenshot of the {% data variables.product.prodname_copilot_short %} chat panel page with "All repositories" highlighted with a dark orange outline.](/assets/images/help/copilot/copilot-chat-all-repositories.png)
32+
33+
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, at the bottom of the chat panel, type "Summarize the purpose of this repository based on the README" and press <kbd>Enter</kbd>. {% data variables.product.prodname_copilot_short %} replies in the chat panel.
34+
35+
You can also use {% data variables.product.prodname_copilot_short %} to understand the roles of different folders and files within the repository. For example, you can ask {% data variables.product.prodname_copilot_short %} to summarize the contents of a specific file, or to explain the purpose of a specific folder.
36+
37+
## Exploring files and code
38+
39+
When you’re exploring a project, you might want to understand the contents of a specific file. {% data variables.product.prodname_copilot_short %} can help you quickly understand the purpose of a file, for example, by providing a summary of the file’s contents. You can also ask {% data variables.product.prodname_copilot_short %} to explain specific lines of code within a file.
40+
41+
{% data reusables.copilot.chat-about-specific-lines %}
42+
43+
## Next steps
44+
45+
Now that you know how to use {% data variables.product.prodname_copilot_short %} to explore projects, you can use it to help you understand any repository, file, or line of code on {% data variables.product.prodname_dotcom %}.

content/get-started/using-github/communicating-on-github.md

+33-5
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ You can create and participate in issues, pull requests and team discussions, de
5959

6060
### Team discussions
6161

62-
* can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion.
63-
* allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes %}
64-
* provide a collaborative experience outside the codebase, allowing the brainstorming of ideas.
65-
* often don’t have a clear owner.
66-
* often do not result in an actionable task.{% endif %}
62+
* Can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion.
63+
* Allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes %}
64+
* Provide a collaborative experience outside the codebase, allowing the brainstorming of ideas.
65+
* Often don’t have a clear owner.
66+
* Often do not result in an actionable task.{% endif %}
6767
{% endif %}
6868

6969
## Which discussion tool should I use?
@@ -148,6 +148,34 @@ The `octocat` team member posted a team discussion, informing the team of variou
148148
* Material about the April All Hands is now available for all team members to view.
149149
{% endif %}
150150

151+
{% ifversion copilot %}
152+
153+
## Using {% data variables.product.prodname_copilot_short %} to gain context
154+
155+
> [!NOTE] {% data reusables.copilot.copilot-requires-subscription %}
156+
157+
If you need more context or clarity on a specific issue or discussion, you can use {% data variables.product.prodname_copilot %} to help answer your questions. This enables you to quickly gain insights, understand complex threads, and stay aligned with the project’s goals, fostering collaboration and knowledge sharing within the community.
158+
159+
To ask a question about an issue or discussion:
160+
161+
1. From anywhere on {% data variables.product.github %}, click the **{% octicon "copilot" aria-hidden="true" %}** {% data variables.product.prodname_copilot %} icon next to the search bar in the top right of the page.
162+
163+
![Screenshot of the new conversation button, highlighted with a dark orange outline.](/assets/images/help/copilot/copilot-icon-top-right.png)
164+
165+
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and include the relevant URL in your message. For example, you could ask:
166+
167+
* `Explain https://github.com/monalisa/octokit/issues/1`
168+
* `Summarize https://github.com/monalisa/octokit/discussions/4`
169+
* `Recommend next steps for https://github.com/monalisa/octokit/issues/2`
170+
* `What are the acceptance criteria for ISSUE URL?`
171+
* `What are the main points made by PERSON in DISCUSSION URL?`
172+
173+
If you chat with {% data variables.product.prodname_copilot %} from a specific issue or discussion, you don't need to include the URL in your question.
174+
175+
{% data reusables.copilot.stop-response-generation %}
176+
177+
{% endif %}
178+
151179
## Next steps
152180

153181
These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs.

content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md

+35
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,41 @@ Below we have added a task list to our Project Octocat issue, breaking it down i
9494

9595
{% endif %}
9696

97+
{% ifversion copilot %}
98+
99+
## Understanding new issues
100+
101+
> [!NOTE] {% data reusables.copilot.copilot-requires-subscription %}
102+
103+
When working on an unfamiliar or complex issue, {% data variables.product.prodname_copilot %} can help you quickly understand the context, history, and key information, so you can get started faster and with more confidence.
104+
105+
### Reviewing the issue
106+
107+
1. Navigate to an issue on {% data variables.product.github %}.
108+
109+
{% data reusables.copilot.open-copilot %}
110+
111+
1. At the bottom of the {% data variables.product.prodname_copilot_short %} chat panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>. For example, you could enter:
112+
113+
* `Summarize the main points of this issue`
114+
* `What’s the goal of this issue?`
115+
116+
{% data variables.product.prodname_copilot_short %}'s summary will help you capture the purpose and scope of the work.
117+
118+
### Understanding the history and comments
119+
120+
Issues often contain a history of discussions and decisions that can provide important context. You can use {% data variables.product.prodname_copilot_short %} to summarize these conversations to identify key points, such as proposed solutions or unanswered questions. For example, you might ask {% data variables.product.prodname_copilot_short %} to summarize recent comments or highlight decisions that have already been made. This helps you focus on what’s most relevant and ensures your contributions are aligned with the team’s priorities.
121+
122+
### Clarifying technical terms
123+
124+
Issues often mention technical terms, code, or files that might not be immediately clear. You can use {% data variables.product.prodname_copilot_short %} to get explanations or context for these references. For example, you can ask about the purpose of a file or function, or the meaning of a specific term mentioned in the issue. This helps you understand the details without spending extra time searching through documentation or code.
125+
126+
### Getting suggestions for next steps
127+
128+
Once you understand the context of an issue, {% data variables.product.prodname_copilot_short %} can help you figure out how to move forward. You can ask for suggestions on how to approach the work, like fixing a bug or implementing a new feature. For example, you might ask, “What’s the best way to resolve this issue?” or “How can I start addressing this problem?” {% data variables.product.prodname_copilot_short %}'s suggestions can provide useful starting points, helping you plan your work more effectively.
129+
130+
{% endif %}
131+
97132
## Making decisions as a team
98133

99134
You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see "[AUTOTITLE](/get-started/using-github/communicating-on-github#which-discussion-tool-should-i-use)."

content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Before you submit your review, your line comments are _pending_ and only visible
5656
You can use [{% data variables.product.prodname_github_codespaces %}](/codespaces/overview) to test, run, and review pull requests.
5757

5858
1. Open the pull request in a codespace, as described in "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests#opening-a-pull-request-in-codespaces)."
59-
1. In the Activity Bar, click the **GitHub Pull Request** view. This view only appears when you open a pull request in a codespace.
59+
1. In the Activity Bar, click the **{% data variables.product.github %} Pull Request** view. This view only appears when you open a pull request in a codespace.
6060

6161
![Screenshot of the {% data variables.product.prodname_vscode_shortname %} Activity Bar. The mouse pointer is hovering over an icon displaying the tooltip "{% data variables.product.prodname_dotcom %} Pull Request."](/assets/images/help/codespaces/github-pr-view.png)
6262

@@ -79,6 +79,33 @@ For more information on reviewing pull requests in {% data variables.product.pro
7979
{% endcodespaces %}
8080
{% endif %}
8181

82+
{% webui %}
83+
{% ifversion copilot %}
84+
85+
## Understanding changes in a pull request
86+
87+
> [!NOTE] {% data reusables.copilot.copilot-requires-subscription %}
88+
89+
{% data variables.product.prodname_copilot %} can help you quickly understand the changes in a pull request by providing context and explanations for specific commits. If you’re unsure about the purpose of a particular change or need more details about how it fits into the broader codebase, you can ask {% data variables.product.prodname_copilot_short %} questions about individual commits.
90+
91+
1. Navigate to a commit on {% data variables.product.github %}.
92+
93+
{% data reusables.copilot.open-copilot %}
94+
95+
1. At the bottom of the {% data variables.product.prodname_copilot_short %} chat panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>. For example, you could enter:
96+
97+
* `Summarize the changes in this commit`
98+
* `Who committed these changes?`
99+
* `When was this commit made?`
100+
101+
> [!TIP]
102+
> If you know the SHA for a commit, instead of navigating to the commit, you can ask {% data variables.product.prodname_copilot_short %} about the commit from any page in the repository on {% data variables.product.github %} by including the SHA in your message. For example, `What changed in commit a778e0eab?`
103+
104+
{% data reusables.copilot.stop-response-generation %}
105+
106+
{% endif %}
107+
{% endwebui %}
108+
82109
## Reviewing dependency changes
83110

84111
If the pull request contains changes to dependencies you can use the dependency review for a manifest or lock file to see what has changed and check whether the changes introduce security vulnerabilities. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."

content/repositories/working-with-files/using-files/index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ versions:
77
ghec: '*'
88
children:
99
- /navigating-code-on-github
10-
- /viewing-a-file
10+
- /viewing-and-understanding-files
1111
- /getting-permanent-links-to-files
1212
- /downloading-source-code-archives
1313
- /working-with-non-code-files
1414
---
15-

0 commit comments

Comments
 (0)