ecbd384482
Co-authored-by: Tim Rogers <timrogers@github.com> Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: github-actions <github-actions@github.com>
276 lines
20 KiB
Markdown
276 lines
20 KiB
Markdown
---
|
|
title: Using GitHub Copilot Chat in GitHub.com
|
|
shortTitle: Using Chat in GitHub.com
|
|
intro: 'You can use {% data variables.product.prodname_copilot_chat_dotcom %} to answer general questions about software development, or specific questions about the code in a repository.'
|
|
versions:
|
|
feature: 'copilot-on-dotcom'
|
|
topics:
|
|
- Copilot
|
|
---
|
|
|
|
## Overview
|
|
|
|
{% data variables.product.prodname_copilot_chat_dotcom %} is a chat interface that lets you ask and receive answers to coding-related questions on {% data variables.product.prodname_dotcom_the_website %}.
|
|
|
|
{% note %}
|
|
|
|
**Note**: {% data variables.product.prodname_copilot_chat_short %} is also available in selected IDEs. For information on using {% data variables.product.prodname_copilot_chat %} in an IDE, see "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)."
|
|
|
|
{% endnote %}
|
|
|
|
{% data variables.product.prodname_copilot_chat_short %} can help you with a variety of coding-related tasks, like offering you code suggestions, providing natural language descriptions of a piece of code's functionality and purpose, generating unit tests for your code, and proposing fixes for bugs in your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat-in-githubcom)."
|
|
|
|
On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask:
|
|
|
|
- General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)."
|
|
- Exploratory questions asked in the context of a specific repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)."
|
|
- Questions asked in the context of a specific repository, file or symbol. For more information, see "[Asking a question about a specific file or symbol](#asking-a-question-about-a-specific-file-or-symbol)."
|
|
- Questions asked in the context of a knowledge base (that is, Markdown documentation across one or more repositories). For more information, see "[Asking a question about a knowledge base](#asking-a-question-about-a-knowledge-base)."
|
|
- Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)."
|
|
- Questions about a pull request diff. For more information, see "[Finding out about the changes in a pull request](#finding-out-about-the-changes-in-a-pull-request)."
|
|
|
|
### Limitations
|
|
|
|
- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository. For more information, see "[Asking a question about a specific repository, file or symbol](#asking-a-question-about-a-specific-repository-file-or-symbol)."
|
|
- The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question.
|
|
|
|
## Prerequisites
|
|
|
|
{% data reusables.copilot.chat-subscription-prerequisite %}
|
|
- To use {% data variables.product.prodname_copilot_chat_dotcom %}, you must have been granted access to {% data variables.product.prodname_copilot_chat %} as part of {% data variables.product.prodname_copilot_enterprise %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)."
|
|
|
|
## Asking a general question about software development
|
|
|
|
You can ask a general question about software development that is not focused on a particular context, such as a repository or a knowledge base.
|
|
|
|
Depending on the question you ask, and your enterprise and organization settings, {% data variables.product.prodname_copilot_short %} may respond using information based on the results of a Bing search. By using Bing search, {% data variables.product.prodname_copilot_short %} can answer a broad range of tech-related questions with up-to-date details based on information currently available on the internet. For information on how to enable or disable Bing search integration, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-features-on-githubcom)."
|
|
|
|
{% note %}
|
|
|
|
**Note:** Bing search integration into {% data variables.product.prodname_copilot_chat_dotcom_short %} is currently in beta and is subject to change.
|
|
|
|
{% endnote %}
|
|
|
|
{% data reusables.copilot.go-to-copilot-page %}
|
|
|
|
1. If the panel is headed "Chatting about OWNER/REPOSITORY," click **All repositories**.
|
|
|
|
|
|
|
|
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is displayed in the panel, click **General purpose chat**.
|
|
|
|
|
|
|
|
1. At the bottom of the panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
|
|
|
Some examples of general questions you could ask are:
|
|
- What are the advantages of the Go programming language?
|
|
- What is Agile software development?
|
|
- What is the most popular JavaScript framework?
|
|
- Give me some examples of regular expressions.
|
|
- Write a bash script to output today's date.
|
|
|
|
1. If {% data variables.product.prodname_copilot_short %} uses a Bing search to answer your question, "Results from Bing" is displayed above the response. Click this to see the search results that {% data variables.product.prodname_copilot_short %} used to answer your question.
|
|
1. Within a conversation thread, you can ask follow-up questions. {% data variables.product.prodname_copilot_short %} will answer within the context of the conversation. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment.
|
|
|
|
You can use your initial question as a foundation for follow-up questions. A detailed foundational prompt can help {% data variables.product.prodname_copilot_short %} provide more relevant answers to your follow-up questions. For more information, see "[Prompting {% data variables.product.prodname_copilot_chat %} to become your personal AI assistant for accessibility](https://github.blog/2023-10-09-prompting-github-copilot-chat-to-become-your-personal-ai-assistant-for-accessibility/)" on the {% data variables.product.prodname_dotcom %} Blog.
|
|
|
|
{% data reusables.copilot.chat-conversation-buttons %}
|
|
|
|
## Asking exploratory questions about a repository
|
|
|
|
{% data variables.product.prodname_copilot_short %} allows you to use natural language questions to explore repositories on {% data variables.product.prodname_dotcom %}. This can help you get a better understanding of where specific aspects of a codebase are implemented.
|
|
|
|
{% data reusables.copilot.go-to-copilot-page %}
|
|
|
|
{% data reusables.copilot.ask-copilot-not-displayed %}
|
|
|
|
{% note %}
|
|
|
|
**Note**:
|
|
|
|
{% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. The indexing status of the repository is displayed when you start a conversation that has a repository context.
|
|
|
|
If you get access to {% data variables.product.prodname_copilot_short %} from the organization that owns the repository, and the repository has not been indexed, an **Index REPOSITORY NAME** button is displayed. Click this button to start the indexing process.
|
|
|
|
|
|
|
|
{% endnote %}
|
|
|
|
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
|
|
|
For example, you could ask:
|
|
|
|
- Where is rate limiting implemented in our API?
|
|
- How does the WidgetFactory class work?
|
|
- Where is the code for converting an organization member to be an outside collaborator?
|
|
- Where are SAT tokens generated?
|
|
|
|
{% data variables.product.prodname_copilot_short %} replies in the chat panel.
|
|
|
|
{% data reusables.copilot.chat-conversation-buttons %}
|
|
|
|
## Asking a question about a specific file or symbol
|
|
|
|
You can ask {% data variables.product.prodname_copilot_short %} about a specific file or symbol within a repository.
|
|
|
|
{% note %}
|
|
|
|
**Note:** A "symbol" is a named entity in code. This could be a variable, function, class, module, or any other identifier that's part of a codebase.
|
|
|
|
{% endnote %}
|
|
|
|
{% data reusables.copilot.go-to-copilot-page %}
|
|
|
|
{% data reusables.copilot.ask-copilot-not-displayed %}
|
|
|
|
1. Click the "Attach files or symbols" button (a paperclip icon) at the bottom of the chat panel, then search for and select one or more files and symbols.
|
|
|
|
|
|
|
|
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
|
|
|
{% data variables.product.prodname_copilot_short %} replies in the chat panel.
|
|
|
|
{% data reusables.copilot.chat-conversation-buttons %}
|
|
|
|
## Asking a question about a knowledge base
|
|
|
|
Organization owners can create knowledge bases, grouping together Markdown documentation across one or more repositories. You can use a knowledge base to ask questions with that context in mind.
|
|
|
|
When you enter a query, {% data variables.product.prodname_copilot_short %} searches for relevant documentation snippets, synthesizes a summary of the relevant snippets to answer your question, and provides links to the source documentation for additional context.
|
|
|
|
{% data reusables.copilot.go-to-copilot-page %}
|
|
|
|
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is not displayed in the panel, click **All repositories**.
|
|
|
|
|
|
|
|
1. Start a conversation with {% data variables.product.prodname_copilot_short %} by either selecting a repository or clicking **General purpose chat**.
|
|
1. Click the "Attach knowledge" button (a book icon) at the bottom of the chat panel, to view a list of the knowledge bases that you have access to.
|
|
|
|
|
|
|
|
1. Click the knowledge base that you want to use as context.
|
|
|
|
For example, you could choose a knowledge base containing your organization's internal developer documentation.
|
|
|
|
You can search for a knowledge base if you don't see one you want to use.
|
|
|
|
|
|
|
|
1. At the bottom of the page, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
|
|
|
|
For example, if you chose a knowledge base with your organization's internal developer documentation, you could ask:
|
|
|
|
- How do I deploy a new application?
|
|
- What's the process for creating a new REST API?
|
|
- What are our best practices for logging?
|
|
|
|
1. The response will typically contain numbered references to files that {% data variables.product.prodname_copilot_short %} uses to generate the answer, from the knowledge base you selected. To list the sources that were used, click **NUMBER references**.
|
|
|
|
|
|
|
|
1. To display information about a source reference, click its entry in the list.
|
|
|
|
Alternatively, to open the complete file, click the ellipsis (**...**), then select **Open**.
|
|
|
|
1. Within a conversation thread, you can ask follow-up questions. Follow-up questions will continue to use the selected knowledge base as context until you explicitly detatch the knowledge base or select a different one.
|
|
|
|
{% data reusables.copilot.chat-conversation-buttons %}
|
|
|
|
## Asking questions about specific pieces of code
|
|
|
|
You can chat with {% data variables.product.prodname_copilot_short %} about a file in your repository, or about specific lines of code within a file.
|
|
|
|
1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository and open a file.
|
|
1. Do one of the following:
|
|
- To ask a question about the entire file, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) at the top right of the file view.
|
|
|
|
|
|
|
|
- To ask a question about specific lines within the file:
|
|
|
|
1. Select the lines by clicking the line number for the first line you want to select, holding down <kbd>Shift</kbd> and clicking the line number for the last line you want to select.
|
|
1. To ask your own question about the selected lines, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) to the right of your selection.
|
|
This displays the {% data variables.product.prodname_copilot_chat %} panel with the selected lines indicated as the context of your question.
|
|
1. To ask a predefined question, click the downward-pointing button beside the {% data variables.product.prodname_copilot_short %} icon, then choose one of the options.
|
|
|
|
|
|
|
|
1. If you clicked the {% data variables.product.prodname_copilot_short %} icon, type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press <kbd>Enter</kbd>.
|
|
|
|
For example, if you are asking about the entire file, you could enter:
|
|
|
|
- Explain this file.
|
|
- How could I improve this code?
|
|
- How can I test this script?
|
|
|
|
If you are asking about specific lines, you could enter:
|
|
- Explain the function at the selected lines.
|
|
- How could I improve this class?
|
|
- Add error handling to this code.
|
|
- Write a unit test for this method.
|
|
|
|
{% data variables.product.prodname_copilot_short %} responds to your request in the panel.
|
|
|
|
|
|
|
|
1. You can continue the conversation by asking a follow-up question. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment.
|
|
1. To clear, delete, or rename the current conversation thread, or to start a new thread, type `/` in the "Ask {% data variables.product.prodname_copilot_short %}" box, select from the options that are displayed, then press <kbd>Enter</kbd>.
|
|
|
|
1. To view a conversation in immersive mode, displaying just the conversation thread, click the dashed box icon at the top right of the conversation thread.
|
|
|
|
|
|
|
|
## Finding out about the changes in a pull request
|
|
|
|
You can ask {% data variables.product.prodname_copilot_short %} to explain what's changed in any of the files in a pull request.
|
|
|
|
1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a pull request in a repository.
|
|
1. Click the **Files changed** tab.
|
|
1. Do one of the following:
|
|
|
|
- To ask a question about a file that's being changed by a pull request, click {% octicon "kebab-horizontal" aria-label="Show options" %} at the top right of the file, then click **Ask {% data variables.product.prodname_copilot_short %} about this diff**.
|
|
- To ask a question about specific lines within a file in the pull request:
|
|
|
|
1. Select the lines by clicking the line number for the first line you want to select, holding down <kbd>Shift</kbd> and clicking the line number for the last line you want to select.
|
|
1. To ask your own question about the selected lines, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) to the right of your selection.
|
|
This displays the {% data variables.product.prodname_copilot_chat %} panel with the selected lines indicated as the context of your question.
|
|
1. To ask a predefined question, click the downward-pointing button beside the {% data variables.product.prodname_copilot_short %} icon and click **Explain**.
|
|
|
|
1. If you clicked the {% data variables.product.prodname_copilot_short %} icon, or you chose **Ask {% data variables.product.prodname_copilot_short %} about this diff**, type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press <kbd>Enter</kbd>. For example, you could enter:
|
|
|
|
- Why has this module been included?
|
|
- What is `actorData` in this line?
|
|
- Explain this `do..end` block.
|
|
- What's the purpose of this file?
|
|
|
|
## Accessing {% data variables.product.prodname_copilot_chat_short %} from the search bar
|
|
|
|
You can ask {% data variables.product.prodname_copilot_short %} a question about an entire repository by typing your question in the main search box of the repository.
|
|
|
|
1. Navigate to a repository on {% data variables.product.prodname_dotcom_the_website %}.
|
|
1. Press <kbd>/</kbd>, or click in the main search box at the top of the page.
|
|
1. In the search box, after `repo:OWNER/REPO`, type the question you want to ask {% data variables.product.prodname_copilot_short %}.
|
|
|
|
For example, you could enter:
|
|
|
|
- What does this repo do?
|
|
- Where is authentication implemented in this codebase?
|
|
- How does license file detection work in this repo?
|
|
|
|
1. Click **Ask {% data variables.product.prodname_copilot_short %}**.
|
|
|
|
|
|
|
|
The {% data variables.product.prodname_copilot_chat %} panel is displayed and {% data variables.product.prodname_copilot_short %} responds to your request.
|
|
|
|
## Sharing feedback about {% data variables.product.prodname_copilot_chat_dotcom %}
|
|
|
|
{% data reusables.rai.copilot-dotcom-feedback-collection %}
|
|
|
|
To give feedback about a particular {% data variables.product.prodname_copilot_chat_short %} response, click either the thumbs up or thumbs down icon at the bottom of each chat response.
|
|
|
|
To give feedback about {% data variables.product.prodname_copilot_chat_short %} in general, click the ellipsis (**...**) at the top right of the chat panel, then click **Give feedback**.
|