diff --git a/CHANGELOG.md b/CHANGELOG.md index 9f4bde9dfc26..3453facddae1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ **13 June 2025** -We've published a new article for people learning to code: "[Developing your project locally](https://docs.github.com/en/get-started/learning-to-code/developing-your-project-locally)." +We've published a new article for people learning to code: "[Developing your project locally](https://docs.github.com/get-started/learning-to-code/developing-your-project-locally)." This tutorial helps learners gain core skills needed to set up any project locally by working through an example client-side application using HTML, CSS, and JavaScript. The goal is to help new coders use GitHub tools to recognize patterns across different technologies and build confidence in their ability to set up any project locally. @@ -12,19 +12,19 @@ This tutorial helps learners gain core skills needed to set up any project local To manage System for Cross-domain Identity Management (SCIM) integration with confidence, customers need to understand the different types of deprovisioning, the actions that trigger them, and their options for reinstating deprovisioned users. -We've published a new article to answer questions around suspending and reinstating Enterprise Managed Users, or users where SCIM is enabled on GitHub Enterprise Server: "[Deprovisioning and reinstating users with SCIM](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/provisioning-user-accounts-with-scim/deprovisioning-and-reinstating-users)". +We've published a new article to answer questions around suspending and reinstating Enterprise Managed Users, or users where SCIM is enabled on GitHub Enterprise Server: "[Deprovisioning and reinstating users with SCIM](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/provisioning-user-accounts-with-scim/deprovisioning-and-reinstating-users)".
**11 June 2025** -We've added a new scenario-based guide for the Builder persona: "[Using Copilot to explore a codebase](https://docs.github.com/en/copilot/using-github-copilot/guides-on-using-github-copilot/using-copilot-to-explore-a-codebase)." +We've added a new scenario-based guide for the Builder persona: "[Using Copilot to explore a codebase](https://docs.github.com/copilot/tutorials/using-copilot-to-explore-a-codebase)."
**24 April 2025** -To help learners feel confident they are building real coding skills while using Copilot, we published [Setting up Copilot for learning to code](https://docs.github.com/en/get-started/learning-to-code/setting-up-copilot-for-learning-to-code). +To help learners feel confident they are building real coding skills while using Copilot, we published [Setting up Copilot for learning to code](https://docs.github.com/get-started/learning-to-code/setting-up-copilot-for-learning-to-code). This article helps learners take their first steps in coding with Copilot acting as a tutor, rather than a code completion tool. Configuring Copilot for learning emphasizes skill development and gives learners a way to use Copilot as a daily tool to foster learning and coding independence. diff --git a/assets/images/help/copilot/code-review/vscode-review-button.png b/assets/images/help/copilot/code-review/vscode-review-button.png new file mode 100644 index 000000000000..5682f8e10d52 Binary files /dev/null and b/assets/images/help/copilot/code-review/vscode-review-button.png differ diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/index.md b/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/index.md index dd33a3f6ec15..1c34afbd11dd 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/index.md +++ b/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/index.md @@ -1,7 +1,7 @@ --- title: 'Understanding your organization''s exposure to vulnerabilities' shortTitle: Exposure to vulnerabilities -intro: 'Understanding your organization’s exposure to vulnerable dependencies is crucial for identifying and prioritizing security risks. This awareness allows you to prioritize remediation efforts, reduce the likelihood of security breaches, protect sensitive data, and maintain the overall integrity and reputation of the organization.' +intro: 'Understanding your organization''s exposure to vulnerable dependencies is crucial for identifying and prioritizing security risks. This awareness allows you to prioritize remediation efforts, reduce the likelihood of security breaches, protect sensitive data, and maintain the overall integrity and reputation of the organization.' versions: feature: dependabot-metrics topics: diff --git a/content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md b/content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md index a49aee634bf3..baff9bfa2e46 100644 --- a/content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md +++ b/content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md @@ -186,7 +186,7 @@ You can request a review for your staged or unstaged changes in {% data variable 1. In {% data variables.product.prodname_vscode_shortname %}, switch to the **Source Control** tab. 1. To request a review on your unstaged changes, hover over **Changes** in the sidebar, and then click the {% data reusables.copilot.code-review.staging-icon-vscode %} **{% data variables.copilot.copilot_code-review_short %} - Changes** button. - ![Screenshot of the "{% data variables.copilot.copilot_code-review_short %} - Changes" button in {% data variables.product.prodname_vscode %}. The code review button is outlined in dark orange.](/assets/images/help/copilot/code-review/vscode-review-button@2x.png) + ![Screenshot of the "{% data variables.copilot.copilot_code-review_short %} - Changes" button in {% data variables.product.prodname_vscode %}. The code review button is outlined in dark orange.](/assets/images/help/copilot/code-review/vscode-review-button.png) 1. To request a review on your staged changes, hover over **Staged Changes** in the sidebar, and then click the {% data reusables.copilot.code-review.staging-icon-vscode %} **{% data variables.copilot.copilot_code-review_short %} - Staged Changes** button. diff --git a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md index 69a5c2deda53..b7fa5ae65c42 100644 --- a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md @@ -401,4 +401,4 @@ To give feedback about {% data variables.copilot.copilot_chat_short %} in genera * [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide) * [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github-mobile) -* [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/using-copilot-to-explore-a-codebase) +* [AUTOTITLE](/copilot/tutorials/using-copilot-to-explore-a-codebase) diff --git a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md index 20e884c305b0..f8bf904bca87 100644 --- a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md @@ -33,7 +33,7 @@ You can ask {% data variables.copilot.copilot_chat_short %} to give you code sug ![Screenshot of the '{% data variables.copilot.copilot_chat_short %}' button, highlighted with a dark orange outline.](/assets/images/help/copilot/vsc-copilot-chat-icon.png) -1. Enter a prompt in the prompt box, or click one of the suggested prompts. For an introduction to the kinds of prompts you can use, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). +1. Enter a prompt in the prompt box, or click one of the suggested prompts. For an introduction to the kinds of prompts you can use, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). 1. Evaluate {% data variables.product.prodname_copilot_short %}'s response, and make a follow-up request if needed. @@ -43,7 +43,7 @@ You can ask {% data variables.copilot.copilot_chat_short %} to give you code sug ## Using keywords in your prompt -You can use special keywords to help {% data variables.product.prodname_copilot_short %} understand your prompt. For examples, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). +You can use special keywords to help {% data variables.product.prodname_copilot_short %} understand your prompt. For examples, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). ### Chat participants @@ -212,7 +212,7 @@ To leave feedback about the {% data variables.copilot.copilot_chat %} extension, You can ask {% data variables.copilot.copilot_chat_short %} to give you code suggestions, explain code, generate unit tests, and suggest code fixes. 1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**. -1. In the {% data variables.copilot.copilot_chat_short %} window, enter a prompt, then press **Enter**. For example prompts, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). +1. In the {% data variables.copilot.copilot_chat_short %} window, enter a prompt, then press **Enter**. For example prompts, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). 1. Evaluate {% data variables.product.prodname_copilot_short %}'s response, and submit a follow up prompt if needed. The response often includes interactive elements. For example, the response may include buttons to copy, insert, or preview the result of a code block. @@ -366,7 +366,7 @@ You can ask {% data variables.copilot.copilot_chat_short %} to give you code sug ![Screenshot of the {% data variables.copilot.copilot_chat %} icon in the Activity Bar.](/assets/images/help/copilot/jetbrains-copilot-chat-icon.png) -1. Enter a prompt in the prompt box. For example prompts, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). +1. Enter a prompt in the prompt box. For example prompts, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). 1. Evaluate {% data variables.product.prodname_copilot_short %}'s response, and submit a follow up prompt if needed. @@ -482,7 +482,7 @@ You can ask {% data variables.copilot.copilot_chat_short %} to give you code sug 1. To open the chat view, click **Editor** in the menu bar, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}** then **Open Chat**. {% data variables.copilot.copilot_chat_short %} opens in a new window. -1. Enter a prompt in the prompt box. For example prompts, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). +1. Enter a prompt in the prompt box. For example prompts, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). 1. Evaluate {% data variables.product.prodname_copilot_short %}'s response, and submit a follow up prompt if needed. @@ -558,13 +558,13 @@ You can ask {% data variables.copilot.copilot_chat_short %} to give you code sug 1. Enter a prompt in the prompt box, then press Enter. - For an introduction to the kinds of prompts you can use, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). + For an introduction to the kinds of prompts you can use, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). 1. Evaluate {% data variables.product.prodname_copilot_short %}'s response, and make a follow up request if needed. ## Using keywords in your prompt -You can use special keywords to help {% data variables.product.prodname_copilot_short %} understand your prompt. For examples, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat). +You can use special keywords to help {% data variables.product.prodname_copilot_short %} understand your prompt. For examples, see [AUTOTITLE](/copilot/get-started/getting-started-with-prompts-for-copilot-chat). ### Slash commands diff --git a/content/copilot/tutorials/comparing-ai-models-using-different-tasks.md b/content/copilot/tutorials/comparing-ai-models-using-different-tasks.md index 2f594b4f7023..67a5c1023bf8 100644 --- a/content/copilot/tutorials/comparing-ai-models-using-different-tasks.md +++ b/content/copilot/tutorials/comparing-ai-models-using-different-tasks.md @@ -173,7 +173,7 @@ class Cart: Consider a scenario where you are implementing both unit tests and integration tests for an application. You want to ensure that the tests are comprehensive and cover any edge cases that you may and may not have thought of. -For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot). +For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/writing-tests-with-github-copilot). ### Why {% data variables.copilot.copilot_claude_sonnet_35 %} is a good fit @@ -188,7 +188,7 @@ For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/using-githu Consider a scenario where you're modernizing a legacy COBOL application by rewriting it in Node.js. The project involves understanding unfamiliar source code, converting logic across languages, iteratively building the replacement, and verifying correctness through a test suite. -For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/modernizing-legacy-code-with-github-copilot). +For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/modernizing-legacy-code-with-github-copilot). ### Why {% data variables.copilot.copilot_claude_sonnet_37 %} is a good fit diff --git a/content/copilot/tutorials/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md b/content/copilot/tutorials/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md index 974caf818381..e15016617b4d 100644 --- a/content/copilot/tutorials/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md +++ b/content/copilot/tutorials/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md @@ -21,7 +21,7 @@ For ease of maintaining code, you might want to move code to a language that is {% data variables.product.prodname_copilot_short %} can help you translate code from one language to another. Translating a standalone file, such as a script, is straightforward. This process is described in this article. -Translating a project containing multiple files is a more complex process, and is described in [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/using-copilot-to-migrate-a-project). +Translating a project containing multiple files is a more complex process, and is described in [AUTOTITLE](/copilot/tutorials/using-copilot-to-migrate-a-project). ## Example scenario diff --git a/content/copilot/tutorials/index.md b/content/copilot/tutorials/index.md index 7205c98edc36..e9c5b323e584 100644 --- a/content/copilot/tutorials/index.md +++ b/content/copilot/tutorials/index.md @@ -14,6 +14,7 @@ children: - /using-copilot-to-explore-a-codebase - /writing-tests-with-github-copilot - /refactoring-code-with-github-copilot + - /learning-a-new-programming-language-with-github-copilot - /modernizing-legacy-code-with-github-copilot - /using-copilot-to-migrate-a-project - /upgrading-java-projects-with-github-copilot @@ -21,4 +22,3 @@ children: redirect_from: - /copilot/using-github-copilot/guides-on-using-github-copilot --- - diff --git a/content/copilot/tutorials/learning-a-new-programming-language-with-github-copilot.md b/content/copilot/tutorials/learning-a-new-programming-language-with-github-copilot.md new file mode 100644 index 000000000000..b393afa0136e --- /dev/null +++ b/content/copilot/tutorials/learning-a-new-programming-language-with-github-copilot.md @@ -0,0 +1,178 @@ +--- +title: Learning a new programming language with GitHub Copilot +shortTitle: Learn a new language +intro: '{% data variables.copilot.copilot_chat %} can help you extend your programming skills by learning how to code in a new programming language.' +topics: + - Copilot +versions: + feature: copilot +--- + +## Introduction + +{% data variables.product.prodname_copilot %} can help you learn how to code: whether you have no prior programming experience, or when you are learning an additional programming language. This guide is all about the latter use case: you already have a good knowledge of how to code in one or more programming languages, but now you want to learn a new language. + +### Prerequisites + +This guide assumes that you know how to use {% data variables.copilot.copilot_chat_short %} and {% data variables.product.prodname_copilot_short %} code completion in your IDE. See [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide) and [AUTOTITLE](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot). + +## Start with the basics + +Use {% data variables.copilot.copilot_chat_short %} to research the basics of the new language. Find out how this language differs from the languages you already know. Ask {% data variables.product.prodname_copilot_short %} to tell you the main things you need to be aware of before you start coding in the new language. + +### Example prompts: language basics + +These are some prompts that you can use in {% data variables.copilot.copilot_chat_short %} to help you learn the basics of a new programming language: + + + +* `What is NEW-LANGUAGE best suited for? I am an experienced Python programmer, but I don't know anything about NEW-LANGUAGE.` + +* `What are the main ways in which NEW-LANGUAGE differs from other languages? Explain the most essential things I need to know as an experienced programmer who wants to learn to code in NEW-LANGUAGE.` + +* `How can I install NEW-LANGUAGE?` + +* `How does error handling work in NEW-LANGUAGE?` + +* `How do you manage dependencies and packages in NEW-LANGUAGE?` + +* `What are the most essential libraries or frameworks I should know about for NEW-LANGUAGE?` + +* `What testing frameworks does the NEW-LANGUAGE community typically use?` + +* `What are the biggest mistakes newcomers to NEW-LANGUAGE typically make with this language?` + +* `As an experienced programmer learning NEW-LANGUAGE, what are the things I should focus on first?` + +## Use {% data variables.product.prodname_copilot_short %} as your personal trainer + +{% data variables.product.prodname_copilot %} can write code for you. You can ask it to create chunks of code, functions, or even entire programs. However, when you are learning a new language, you should avoid relying on {% data variables.product.prodname_copilot_short %} to write much of the code for you—especially if you accept the code it suggests without making sure you understand it. If you don't know the language, you won't know if the code {% data variables.product.prodname_copilot_short %} suggests is as good as it could be. Instead, you should treat {% data variables.product.prodname_copilot_short %} as your personalized training assistant. + +When you ask {% data variables.product.prodname_copilot_short %} how to code something specific in the new language, you should ask it to explain the code it suggests. If you don't completely understand the code, or {% data variables.product.prodname_copilot_short %}'s description of it, ask for a simplified explanation—or ask for more detail—until you are sure you understand the code. Always avoid using any code that you are not completely confident that you understand. + +### Example prompts: asking for an explanation + + + +* `Explain your previous suggestion in more detail. I am new to NEW-LANGUAGE and I don't understand the code you suggested.` + +* ``Show me how to write the following Ruby code in NEW-LANGUAGE: `people_over_50 = people.select { |person| person.age > 50 }`. Explain each part of the NEW-LANGUAGE code that you suggest.`` + +* `Add comprehensive comments to this NEW-LANGUAGE file to explain what each part of the code does.` + +## Write a simple program in the new language + +To get started, write a simple program that you would be able to write easily in a language you already know. Ask {% data variables.product.prodname_copilot_short %} for help. If you prefer, you can ask {% data variables.product.prodname_copilot_short %} to write a very simple program for you, just to get you started. You can then examine the code, learn how it works, and then extend the program yourself. + +### Example prompts: writing a simple program + + + +* `Show me the Rust code for a simple, useful command line tool that asks for user input and returns some useful information based on what was entered.` + +* `Comment the suggested code more thoroughly. I want to understand what every part of this code does.` + +* `Give me the code for a very small Android app written in Kotlin.` + +* `Suggests ways I could enhance this app.` + +### Use comments and {% data variables.product.prodname_copilot_short %} code completion + +As an alternative to asking {% data variables.copilot.copilot_chat_short %} to suggest the basic code for a new program, you can write comments in the editor and see what suggestions {% data variables.product.prodname_copilot_short %} code completion offers. + +For example: + +1. In your IDE, create a file with an appropriate file name extension for the language you are using. For example, if you are learning Rust, create a file called `example.rs`. +1. Copy and paste the following comment lines. + + ```rust copy + // NEW-LANGUAGE command line program to find the day of the week for a date. + // The program does the following: + // Prompt user to input string in format YYYYMMDD + // Parse the string to check that it is a valid date. + // If it's not, print an error message and exit. + // Calculate the day of the week for the given date. + // Print the day of the week to the user. + ``` + +1. If necessary, change the comment syntax to match the language you are using. +1. Change `NEW-LANGUAGE` to the name of the language you are using. This, and the file name extension, will tell {% data variables.product.prodname_copilot_short %} which language to use. +1. Press return and tab to see and accept the code completion suggestions that {% data variables.product.prodname_copilot_short %} offers. Continue accepting suggestions until you have a complete program. +1. Read through the code to see how it works. If you don't understand any part of the code, ask {% data variables.product.prodname_copilot_short %} to explain it. For example: + + 1. Select one or more lines of code that you don't understand. + 1. **In {% data variables.product.prodname_vscode_shortname %}:** + + Right-click the selected code and choose **{% data variables.product.prodname_copilot_short %}** > **Explain**. + + **In JetBrains IDEs:** + + Right-click the selected code and choose **{% data variables.product.prodname_copilot %}** > **Explain This**. + + **In {% data variables.product.prodname_vs %}:** + + Open the {% data variables.copilot.copilot_chat_short %} panel and enter the prompt `Explain this code`. + +## Ask {% data variables.product.prodname_copilot_short %} specific questions + +While you are learning a new language, you should work on small units of code that perform a specific task. Ask {% data variables.product.prodname_copilot_short %} well-defined, narrowly scoped questions to help you become familiar with the syntax and idioms of the new language. + +### Example prompts: specific questions + + + +* `Explain all of the various ways that conditionals can be coded in NEW-LANGUAGE.` + +* ``In JavaScript I'd write: `The ${numCats === 1 ? 'cat is' : 'cats are'} hungry.`. How do I write this in NEW-LANGUAGE?`` + +* `In NEW-LANGUAGE, how do I convert a string to all lowercase?` + +* `What is the equivalent of num++ in NEW-LANGUAGE?` + +* `How do I run a program written in the NEW-LANGUAGE programming language?` + +* `How can I compile a single executable file for my NEW-LANGUAGE project, that I can distribute as a release?` + +## Convert existing code to the new language + +One effective way of leveraging your existing programming knowledge is to take some code you are familiar with in one language, convert it to the new language, and then examine how the same operation is done in the new language. + +1. Find a self-contained piece of code. For example, a function. +1. Ask {% data variables.copilot.copilot_chat_short %} to convert it into the language you are learning. +1. Copy and paste the suggested code into a new file in your editor. +1. View the two pieces of code side by side and analyze how the same operation is done in the new language. What are the similarities and differences? +1. Get {% data variables.product.prodname_copilot_short %} to explain any of the code you don't understand. + +## Read existing code in the new language + +After you feel comfortable with the basics of the new language, spend time reading existing code written in that language. + +Find a project that uses the new language and take a look at the code. Open a file and ask {% data variables.copilot.copilot_chat_short %} for a brief overview of the purpose of the file. Then read through the code line by line. Do you understand the techniques that have been used? Do you know how the library and built-in functions work? Can you follow the data flow through the code? + +Ask {% data variables.product.prodname_copilot_short %} to explain any parts of the code that you don't understand. + +When you have finished reading through the code, ask {% data variables.product.prodname_copilot_short %} whether it can suggest any ways to improve the code. + +## Avoid assuming that {% data variables.product.prodname_copilot_short %} is always right + +{% data variables.product.prodname_copilot_short %} is a tool that can help you learn a new language, but—like all AI assistants—it is not infallible. It can make mistakes, and it can suggest code that is not optimal. + +{% data variables.product.prodname_copilot_short %} is trained on a large body of code but, for each language, the quality of suggestions you receive may depend on the volume and diversity of training data for that language. For example, JavaScript is well-represented in public repositories and {% data variables.product.prodname_copilot_short %} will therefore typically be able to provide accurate and helpful suggestions. The quality of {% data variables.product.prodname_copilot_short %}'s suggestions may be lower for languages that are less well-represented in public repositories. + +Always check the code that {% data variables.product.prodname_copilot_short %} suggests, and make sure you understand it before you use it. When you're checking code suggested by {% data variables.product.prodname_copilot_short %}, you should look for ways you could make the code more performant, simpler, or easier to maintain. + +If you think {% data variables.product.prodname_copilot_short %} has not suggested the best way of coding something you can ask it to try a different approach. + +If you run the code and it generates an error, give {% data variables.product.prodname_copilot_short %} the details of the error and ask it to fix the code. + +You should also check that {% data variables.product.prodname_copilot_short %} is following your coding style guidelines. If it is not, you can alter the repository's custom instructions to prompt {% data variables.product.prodname_copilot_short %} to adhere to your guidelines in future. See [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot). + +### Example prompts: checking your work + + + +* `Check this code for syntax errors.` + +* `Assess whether this code is optimally performant.` + +* `Suggest alternative ways this code could have been written.` diff --git a/content/copilot/tutorials/using-copilot-to-migrate-a-project.md b/content/copilot/tutorials/using-copilot-to-migrate-a-project.md index 8fb2696d4212..4be91e5267d5 100644 --- a/content/copilot/tutorials/using-copilot-to-migrate-a-project.md +++ b/content/copilot/tutorials/using-copilot-to-migrate-a-project.md @@ -71,7 +71,7 @@ Assuming you've already familiarized yourself with the existing project, a good If you think a change suggested by {% data variables.product.prodname_copilot_short %} is not right in some way, ask for an alternative suggestion. 1. As soon as you've migrated a component to a state that you can run, check that it works as expected. If it generates an error, copy the error into the {% data variables.copilot.copilot_chat_short %} view, and ask {% data variables.product.prodname_copilot_short %} to help you fix it. -1. After you've completed the initial conversion, use {% data variables.product.prodname_copilot_short %} to help you refactor the code in the new language. For more information, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/refactoring-code-with-github-copilot). +1. After you've completed the initial conversion, use {% data variables.product.prodname_copilot_short %} to help you refactor the code in the new language. For more information, see [AUTOTITLE](/copilot/tutorials/refactoring-code-with-github-copilot). ## Example: migrating a PHP project to Python diff --git a/content/get-started/exploring-projects-on-github/using-github-copilot-to-explore-projects.md b/content/get-started/exploring-projects-on-github/using-github-copilot-to-explore-projects.md index 791859858c33..a8628a2df6f5 100644 --- a/content/get-started/exploring-projects-on-github/using-github-copilot-to-explore-projects.md +++ b/content/get-started/exploring-projects-on-github/using-github-copilot-to-explore-projects.md @@ -40,7 +40,7 @@ When you’re exploring a project, you might want to understand the contents of ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/using-copilot-to-explore-a-codebase) +* [AUTOTITLE](/copilot/tutorials/using-copilot-to-explore-a-codebase) ## Next steps diff --git a/content/repositories/working-with-files/using-files/viewing-and-understanding-files.md b/content/repositories/working-with-files/using-files/viewing-and-understanding-files.md index 77923b4d7e4e..b36e7f514bc0 100644 --- a/content/repositories/working-with-files/using-files/viewing-and-understanding-files.md +++ b/content/repositories/working-with-files/using-files/viewing-and-understanding-files.md @@ -66,7 +66,7 @@ All revisions specified in the `.git-blame-ignore-revs` file, which must be in t 1. Commit and push the changes. -Now when you visit the blame view, the listed revisions will not be included in the blame. You'll see an **Ignoring revisions in .git-blame-ignore-revs** banner indicating that some commits may be hidden: +In the blame view, revisions are excluded only if the commit **introduced new lines**. If the commit was the last to **modify** a line, it will still appear in blame. You'll see an "Ignoring revisions in .git-blame-ignore-revs" banner indicating that some commits may be hidden: diff --git a/data/code-languages.yml b/data/code-languages.yml index 9cc5469ea269..e6b3e17cf852 100644 --- a/data/code-languages.yml +++ b/data/code-languages.yml @@ -55,6 +55,9 @@ python: ruby: name: Ruby comment: number +rust: + name: Rust + comment: number scss: name: SCSS comment: slash