New Module: GitHub Copilot

[rmallorybpc]

We need to create a dedicated module for Projects.

Copilot uses the OpenAI Codex to suggest code and entire functions in real-time, right from your editor.

Plan of Action

• [x] Research and record current publicly available content
• [x] Determine if Copilot and Copilot for Business are needed
  • ~If yes, then continue Copilot here and write Copilot for Business in #55~
  • [x] If no, then continue here and note in #55
• [x] Create module table of contents outline
• [x] Review module outline
• [x] Plan the content for the new module
• [x] Create scaffolding for the new module
• [x] Write content
• [x] Write knowledge check questions
• [x] Add durationinminutes to .yaml files
  • [x] Every unit
  • [ ] The full module
• [x] Add, How to provide feedback
• [x] Add the unit file titles in yaml and md
• [x] Check yaml files making Aaron the author, until we have a group to add instead (ms.author unchanged)
• [x] Edit review (@camihmerhar)
• [x] Review the latest GitHub Copilot for Business blog post
• [x] Feedback from dhruvg20
• [x] Cami review 2!
• [x] Spell check all units
• [ ] Review the module (Aaron)
  • [ ] Verify images added in units: 2-using-github-copilot and 4-configure-github-copilot
  • [ ] Note in units: 2-using-github-copilot (in markdown) about an image conversion under the section, Assisting non-native English speakers
  • [ ] Notes in unit, 4-configure-github-copilot (in markdown), about an image conversion under the section, Configuring GitHub Copilot in Visual Studio Code. And under the section, Configuring GitHub Copilot in Visual Studio
  • [ ] Review unit, 4-configure-github-copilot.md, to see if the amount of content needs a new module at this point
    • If no, we should keep this in mind when more content and customization content is available

[rmallorybpc]

Research and record current publicly available content

Copilot - GitHub features General What is GitHub Copilot? GitHub Copilot is an AI pair programmer that helps you write code faster and with less work. It draws context from comments and code to suggest individual lines and whole functions instantly. GitHub Copilot is powered by OpenAI Codex, a generative pretrained language model created by OpenAI. It is available as an extension for Visual Studio Code, Visual Studio, Neovim, and the JetBrains suite of integrated development environments (IDEs).

Copilot blog search keyword GitHub Copilot blog GA GitHub Copilot docs Introduction GitHub Copilot is an AI pair programmer. You can use GitHub Copilot to get suggestions for whole lines or entire functions right inside your editor.

This guide will show you how to sign up for GitHub Copilot through your personal account, install the GitHub Copilot extension in Visual Studio Code, and get your first suggestion. For more information on GitHub Copilot, see "About GitHub Copilot." For more in-depth information on how to use GitHub Copilot in a variety of environments, see "Getting Started.

• Getting started with GitHub Copilot in Visual Studio Code
• Getting started with GitHub Copilot in a JetBrains IDE
• Getting started with GitHub Copilot in Visual Studio
• Getting started with GitHub Copilot in Neovim
• About billing for GitHub Copilot
• Configuring GitHub Copilot settings on GitHub.com
• Troubleshooting GitHub Copilot

GitHub Copilot label copilot

GitHub Copilot is generally available for businesses Enabling GitHub Copilot for Business for your enterprise

[rmallorybpc]

Module Outline

Introduction to GitHub Copilot

Exam landing page Quick intro sentence, Learning objectives, Prerequisites, Units outline

What is GitHub Copilot

Introduction unit

• https://github.blog/?s=copilot

Introduce GitHub Copilot

• https://github.com/features/copilot
• https://github.blog/2022-06-21-github-copilot-is-generally-available-to-all-developers/
• https://docs.github.com/en/copilot/overview-of-github-copilot/about-github-copilot
• https://github.com/features/copilot/#faq

Introduce GitHub Copilot for Business

• https://github.blog/2022-12-07-github-copilot-is-generally-available-for-businesses/
• https://docs.github.com/en/enterprise-cloud@latest/copilot/overview-of-github-copilot/about-github-copilot-for-business

How to use GitHub Copilot

Using GitHub Copilot

• https://docs.github.com/en/copilot/overview-of-github-copilot/about-github-copilot#using-github-copilot
• https://github.blog/2022-09-14-8-things-you-didnt-know-you-could-do-with-github-copilot/
• https://github.blog/2022-07-14-research-how-github-copilot-helps-improve-developer-productivity/

Enable GitHub Copilot for Business for your enterprise

Using GitHub Copilot for Business

• https://docs.github.com/en/enterprise-cloud@latest/copilot/overview-of-github-copilot/about-github-copilot-for-business#setting-up-github-copilot-for-business

Configure GitHub Copilot

Configure GitHub Copilot

• https://docs.github.com/en/copilot/configuring-github-copilot
  • Configuring GitHub Copilot settings on GitHub.com
  • Configuring GitHub Copilot in Visual Studio Code
  • Configuring GitHub Copilot in Visual Studio
  • Configuring GitHub Copilot in a JetBrains IDE
  • Configuring GitHub Copilot in Neovim

Troubleshoot GitHub Copilot

Information for troubleshooting GitHub Copilot

• https://docs.github.com/en/copilot/troubleshooting-github-copilot
  • Troubleshooting GitHub Copilot in Visual Studio Code
  • Troubleshooting GitHub Copilot in Visual Studio
  • Troubleshooting GitHub Copilot in a JetBrains IDE
  • Troubleshooting GitHub Copilot in Neovim
  • Troubleshooting certificate errors for GitHub Copilot

Skills

Need to find out if there are or will be Skills or exercises to add

Summary

Summary, References

[rmallorybpc]

Feedback from @camihmerhar

Howdy @rmallorybpc! Awesome job putting this together! Let me know if you have any questions.

Feedback on Introduction to GitHub Copilot

• [x] Do we have an introduction for this module with the prerequisites? I think knowing that will help inform us of how we curate the content going forward.

1-what-is-github-copilot.md

• [X] In the first sentence of the unit, depending on the level of learner, should we write out Artificial Intelligence before we use the acronym?

2-how-to-use-github-copilot.md

• [x] I would consider rewording the title of the unit from "How to use github copilot," to something along the lines of "Testing and Securing Code with Copilot," that way learners know what to expect with the unit.
• [x] After the sentence "You can write a comment describing the logic you want and GitHub Copilot will immediately suggest code to implement the solution," I would add a transition sentence that introduces the sub sections.
• [x] I feel like the sub section "Assisting non-native English speakers" feels out of place. I feel like it might be a better fir for the 3rd learning unit, "Enable GitHub Copilot for Business Enterprise" and you can intro it with a transition sentence that states that teams can be global and that's why assisting non-native english speakers is so important.

3-enable-github-copilot-for-business-enterprise.md

• [x] I feel like we need an intro to this unit stating the value case for using GitHub Copilot for Business and examples of how it can help business
• [x] For the last portion of the unit, "Enforcing a policy to manage the use of GitHub Copilot for Business in your Enterprise" in GitHub Docs... I would bullet the content afterwards to make it easier for the reader and providing images of the steps as well.

4-configure-github-copilot.md

• [x] I feel like this needs a marketing propositional statement as to why this is important and how it relates to the following subsections and then a table of contents of the subsections at the very beginning of the unit.

Enabling or disabling duplication detection

• [x] Should "An inventory of similar code found in GitHub public repositories" be in courier font?
• [x] Bullet out the steps to make them more digestible

Enabling or disabling telemetry

• [x] "Enabling or disabling telemetry allows you to choose whether your code snippets are collected and retained by GitHub and further processed, And, shared with Microsoft and OpenAI by adjusting your user settings" lowercase A in And

Configuring GitHub Copilot in Visual Studio Code

• [x] After the first paragraph of this section what are your thoughts on walking through the steps of installing GH Copilot for Visual Studio?
• [x] After the 3rd paragraph of this section I feel like a picture would go well there

Configuring GitHub Copilot in Visual Studio

• [x] Thoughts on an image in this section?

Configuring ReSharper for GitHub Copilot

• [x] I feel like we need more context here why is it best and why is this important?
• [x] I also feel like the last sentence in the paragraph needs to be bulleted or numbered into steps.

Configuring GitHub Copilot in a JetBrains IDE

• [x] Do we have more information on this? I feel like this function is amazing! Are there any stats that shows how this saves people time? Also do we steps to show people how to enable this?

Configuring GitHub Copilot in Neovim

• [x] I think we need to dive into why this is important and how it can help someone.

5-troubleshoot-github-copilot.md

• [x] I think it would be helpful to have a table of contents for the upcoming subsections in order to prep the learner for what is to come.

Troubleshooting GitHub Copilot in Visual Studio Code

• [x] I feel like we need to open this with something along the lines of "In Visual Studio Code the log files are useful for diagnosing connection issues." that way learners know they are in the right place.

Troubleshooting GitHub Copilot in Visual Studio

• [x] Because this section is so small can we combine it with the above section? If no, what are the discernible differences between the two?

7-summary.md

• [x] "GitHub Copilot is an AI pair programmer that suggests code in your editor." I would delete this, I feel like we already established this and it's a bit unnecessary.

[rmallorybpc]

Feedback on Introduction to GitHub Copilot

• Do we have an introduction for this module with the prerequisites? I think knowing that will help inform us of how we curate the content going forward.

Hey @camihmerhar the module opening is in the Index. Revised after our MS Learn weekly.

[rmallorybpc]

@camihmerhar more comments below.

2-how-to-use-github-copilot.md

• I would consider rewording the title of the unit from "How to use github copilot," to something along the lines of "Testing and Securing Code with Copilot," that way learners know what to expect with the unit.
• I feel like the sub section "Assisting non-native English speakers" feels out of place. I feel like it might be a better fit for the 3rd learning unit, "Enable GitHub Copilot for Business Enterprise" and you can intro it with a transition sentence that states that teams can be global and that's why assisting non-native english speakers is so important.

I updated the unit titles to start. I added a better intro to this unit with a new, using, unit. A new blog post (added to the Summary as well) helped a lot. I moved the, non-native, section to the bottom with a better transition. I kept the section here, but let me know if you still think the read flows better with, non-native, in Business or not.

[rmallorybpc]

@camihmerhar comments below.

Troubleshooting GitHub Copilot in Visual Studio

• [ ] Because this section is so small can we combine it with the above section? If no, what are the discernible differences between the two?

These are specific troubleshooting for the two products, Visual Studio Code and Visual Studio.

[rmallorybpc]

Comments below, @camihmerhar

4-configure-github-copilot.md

Configuring GitHub Copilot in Visual Studio Code

• [x] After the first paragraph of this section what are your thoughts on walking through the steps of installing GH Copilot for Visual Studio?

I added an image suggestion.

[rmallorybpc]

From @camihmerhar

Howdy @rmallorybpc! I hope you had a fabulous weekend!

Here are my next round of reviews, let me know if you have any questions!

1-introduction.md

• [x] Super minor but I would break up this paragraph to make it easier to read:

"GitHub Copilot is an Artificial Intelligence (AI) pair programmer that helps you write code faster and with less work.

GitHub Copilot draws context from comments and code to suggest individual lines and whole functions instantly.

Powered by OpenAI Codex, GitHub Copilot's generative pretrained language model is created by OpenAI. An extension is available for Visual Studio Code, Visual Studio, Neovim, and the JetBrains suite of integrated development environments (IDEs)."

• [x] To make the content easier to digest and the module easier to navigate, I would align the learning objectives to each of the modules
• [x] Should the prer-reqs " Introduction to GitHub" and "Introduction to GitHub" be a "A basic or intermediate level of understanding of GitHub and GitHub Administration"? Not sure what it means as of right now.
  • These are MS Learn modules. I added a MS Learn module comment
• [x] The transition statement at the end of the introduction sounds a bit choppy may say something like, "Next up, let's dive into learning about GitHub Copilot."

1-about-copilot.md

• [x] This unit seems a bit short, I think it might make sense to combine with the next unit. I think it also might help the flow of the module where we introduce copilot and then follow up with its functionality.
  • I added content

2-using-github-copilot.md

• [ ] I would consider rewording the title of the unit from "Using github copilot," to something along the lines of "Learning about Testing and Securing Code with Copilot," that way learners know what to expect with the unit.
  • I kept this less specific to keep to the intro-type of title. I can be convinced otherwise
• [x] Maybe it's just me and my unfamiliarity with Copilot, but I was expecting an image or a gif of Copilot helping suggest code or testing and securing it.
  • There is one image and one comment pending for the type of image available. Unfortunately, we cannot see the images in the preview view.

Assisting non-native English speakers

• [x] "Importantly, GitHub Copilot can assist non-native English speakers and can understand other languages beyond English." I feel like we need a stronger transition here. Like, "We know that teams are diverse and span across the globe. That is why it was important to GitHub to add functionality to help non-native English speakers use GitHub Copilot with ease." And then remove "Importantly..." and start the next sentence as "GitHub Copilot can understand languages beyond English, helping developers of all backgrounds with program languages that are based on American English."

3-enable-github-copilot-for-business-enterprise.md

Enabling GitHub Copilot for Business for your enterprise

• [x] While revisiting the steps to manage GitHub Copilot for Business, I would break the steps out into different sections and then have the steps numbered. The different sections should be: "How to disable and enable GitHub Copilot for all Organizations" and "How to Enable GitHub Copilot Specific Organizations." I think this will make it easier for the learner to digest.
  • Reworked the section
• [x] Should "These steps are also found in: Enforcing a policy to manage the use of GitHub Copilot for Business in your enterprise” in the GitHub Docs" be linked?
  • We were previously not linking out, but I did update the location (I think the page changed) and added the link.

4-configure-github-copilot.md

• [x] I don't think you the comma in "GitHub Copilot generates new code in a probabilistic way. The models do not contain a database of code, and do not look up snippets."
• [x] I would add in a table of contents cuing up the learner for the unit that includes the subsection in this unit. I think this will make it a bit more digestible.

Configuring GitHub Copilot settings on GitHub.com

• [x] Do we have steps to do this? Should we list them here?

Enabling or disabling telemetry

• [x] Change snipper to snippet in the following sentence, "Additionally, you can choose if your code snipper is further processed and shared with Microsoft and OpenAI by adjusting your user settings."

Configuring ReSharper for GitHub Copilot

• [x] I think it might just be me, but if a title has Configuring in it, I expect step by step instructions on how to configure the tool, maybe we should rename "How ReSharper can assist GitHub Copilot"

Configuring GitHub Copilot in a JetBrains IDE

• [x] Similar to the above comment but for this section
  • There is a statement in the unit that the UI changes per version and GitHub does not have steps included in the docs. I did add a comment about using the same steps as above for telemetry and duplication detection.

Configuring GitHub Copilot in Neovim

• [x] Similar to the above comment but for this section
  • This is done by using the code snippet in Neovim. No steps are listed in the GitHub docs.

[a-a-ron]

Module added. Closing issue