Add copilot for VS

ps-copilot-sandbox · Jul 11, 2023 · 47c5699 · 47c5699
1 parent 7acf6d6
commit 47c5699
Show file tree

Hide file tree

Showing 52 changed files with 156 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# How to contribute
+
+As a Solutions Engineer in PEX, you want to contribute to this repo to help customers to get started with Copilot for C# and .NET. You can contribute to this repo by adding new demos or improving existing demos.
+
+Try to be descriptive as much as possible! Capture screenshots and link to your documentation so it is easier to follow for everyone.
+
+## How to add a new demo
+
+1. Create a new branch from `main` branch. The branch name should be descriptive and should not contain any spaces. For example, `create-new-demo` is a good name for a branch.
+2. Create a new folder for your demo under `Demo`. The folder name should be descriptive and should not contain any spaces. For example, `GettingStarted` is a good name for a folder.
+3. Add a file named `README.md` in the folder. This file should contain the demo instructions. You can use [this template](README_TEMPLATE.md) as a starting point.
+4. If you have any script, you need to add to the folder. For example, if you have a notebook, you need to add it to the folder. You can add any other files that are needed for the demo. If you have images, you can create a new folder called `images` in your own folder, and add images to that folder. Link the images to your documentation.
+5. Update `README.md` in the root of repository to update the index of demos.
+6. Create a pull request to merge your branch to `main` branch.
+
+## How to improve an existing demo
+
+If you see any typo or information that needs to be updated, you can create a pull request to update the demo. You can also create a pull request to add more information to the demo.
+
+## If you don't have access to the repository but still want to contribute...
+
+Create an Issue with your feedback or suggestion. We will review it and add it to the repository.
+
diff --git a/CopilotExtensionVS/README.md b/CopilotExtensionVS/README.md
@@ -0,0 +1,98 @@
+# How to install Copilot Extension for Visual Studio IDE
+
+This shows how to install Copilot Extension for Visual Studio IDE. You need to install Visual Studio IDE first before you can install Copilot Extension for Visual Studio IDE.
+
+## Step 1: Install Visual Studio IDE
+
+You need to make sure that you installed **Vistual STudio IDE** before installing Copilot extension for Visual Studio IDE.
+
+[Download Visual Studio](https://visualstudio.microsoft.com/downloads/).
+
+> Note that GitHub Copilot for Visual Studio IDE is only available for Windows. If you are using Mac, you can use Copilot through VS Code.
+
+## Step 2: Install Extensions
+
+You can install Copilot extension for Visual Studio IDE through Visual Studio IDE or through Visual Studio Marketplace.
+
+Click **Extensions** in your toolbar then click **Manage Extensions**.
+
+![Manage Extensions](./images/0_ManageExtension.jpg)
+
+Then search for **Copilot** and click **Download**.
+
+![Search for Copilot](./images/1_SearchCopilot.jpg)
+
+It will be asked to exit Visual Studio IDE.
+
+![Exit Visual Studio IDE](./images/2_ExitVS.jpg)
+
+### Possible error message
+
+If you are using an existing Visual Studio IDE, you might get an error message like this:
+
+![Error message](./images/3_PossibleError.jpg)
+
+You can also click **View Install Log** to see the details of the error message. 
+
+![About Visual Studio IDE](./images/4_ErrorLogjpg)
+
+If so, you need to update to the latest version of Visual Studio IDE. Click **Help** then select **About Microsoft Visual Studio** to check the version of Visual Studio IDE.
+
+![About Visual Studio IDE](./images/5_AboutVS.jpg).
+
+If you are using an older version of Visual Studio IDE, you need to update to the latest version of Visual Studio IDE. Under **Help**, click **Check for Updates**.
+
+![Check for Updates](./images/6_CheckForUpdate.jpg)
+
+Then, in the pop-up window, click **Update** after checking your version.
+
+![Update Visual Studio IDE](./images/7_Update.jpg)
+
+
+## Step 3: Installing Copilot
+
+After you exit Visual Studio IDE, you will be asked to install Copilot with a following pop-up window. Click **Modify**.
+
+![Modify](./images/8_StartInstall.jpg)
+
+You will see a progress bar.
+
+![Progress bar](./images/9_InstallProgress.jpg)
+
+Once it is done, you will see a pop-up window like this. Click **Close**.
+
+![Completed](./images/10_InstallDone.jpg)
+
+## Step 4: Configure Copilot
+
+Open your Visual Studio IDE. At the bottom, you might notice that **Ouput** window shows that **Auth Status** as **NotSignedIn**.
+
+And on the top, you will see a message indicating that you need to add your GitHub account to use Copilot.
+
+![Not Signed In](./images/11_VSCode.jpg)
+
+Make sure that you notice that **Auth Status** is **NotSignedIn**. If you don't see that window, you can try to open one.
+
+![Output Window](./images/12_NotInstalled.jpg)
+
+On the top, click **Add GitHub Account**.
+
+![Add GitHub Account](./images/13_AddAccount.jpg)
+
+You will see a pop-up window like this. Either add a new GitHub Account or reconnect GitHub Account.
+
+![Sign In](./images/14_SigIn.jpg)
+
+Once you sign in, you will see that your account is connected.
+
+![Connected](./images/15_AccountAdded.jpg)
+
+Then, you can see that **Ouput** message shows that you are succesfully signed in.
+
+![Signed In](./images/16_Success.jpg)
+
+## Step 5: Try Copilot
+
+Now, you can try Copilot. Create a new project and add a new file. Then, you will see that Copilot is working.
+
+![Copilot](./images/17_Copilot.jpg)
diff --git a/CopilotExtensionVS/images/0_ManageExtension.jpg b/CopilotExtensionVS/images/0_ManageExtension.jpg
diff --git a/CopilotExtensionVS/images/10_InstallDone.jpg b/CopilotExtensionVS/images/10_InstallDone.jpg
diff --git a/CopilotExtensionVS/images/11_VSCode.jpg b/CopilotExtensionVS/images/11_VSCode.jpg
diff --git a/CopilotExtensionVS/images/12_NotInstalled.jpg b/CopilotExtensionVS/images/12_NotInstalled.jpg
diff --git a/CopilotExtensionVS/images/13_AddAccount.jpg b/CopilotExtensionVS/images/13_AddAccount.jpg
diff --git a/CopilotExtensionVS/images/14_SignIn.jpg b/CopilotExtensionVS/images/14_SignIn.jpg
diff --git a/CopilotExtensionVS/images/15_AccountAdded.jpg b/CopilotExtensionVS/images/15_AccountAdded.jpg
diff --git a/CopilotExtensionVS/images/16_Success.jpg b/CopilotExtensionVS/images/16_Success.jpg
diff --git a/CopilotExtensionVS/images/17_Copilot.jpg b/CopilotExtensionVS/images/17_Copilot.jpg
diff --git a/CopilotExtensionVS/images/1_SearchCopilot.jpg b/CopilotExtensionVS/images/1_SearchCopilot.jpg
diff --git a/CopilotExtensionVS/images/2_ExitVS.jpg b/CopilotExtensionVS/images/2_ExitVS.jpg
diff --git a/CopilotExtensionVS/images/3_PossibleError.jpg b/CopilotExtensionVS/images/3_PossibleError.jpg
diff --git a/CopilotExtensionVS/images/4_ErrorLog.jpg b/CopilotExtensionVS/images/4_ErrorLog.jpg
diff --git a/CopilotExtensionVS/images/5_AboutVS.jpg b/CopilotExtensionVS/images/5_AboutVS.jpg
diff --git a/CopilotExtensionVS/images/6_CheckForUpdate.jpg b/CopilotExtensionVS/images/6_CheckForUpdate.jpg
diff --git a/CopilotExtensionVS/images/7_Update.jpg b/CopilotExtensionVS/images/7_Update.jpg
diff --git a/CopilotExtensionVS/images/8_StartInstall.jpg b/CopilotExtensionVS/images/8_StartInstall.jpg
diff --git a/CopilotExtensionVS/images/9_InstallProgress.jpg b/CopilotExtensionVS/images/9_InstallProgress.jpg
diff --git a/Demos/GettingStarted/README.md b/Demos/GettingStarted/README.md
diff --git a/Demos/GettingStarted/images/0_SearchVS.jpg b/Demos/GettingStarted/images/0_SearchVS.jpg
diff --git a/Demos/GettingStarted/images/10_Complete.jpg b/Demos/GettingStarted/images/10_Complete.jpg
diff --git a/Demos/GettingStarted/images/11_AddReadline.jpg b/Demos/GettingStarted/images/11_AddReadline.jpg
diff --git a/Demos/GettingStarted/images/12_Readline.jpg b/Demos/GettingStarted/images/12_Readline.jpg
diff --git a/Demos/GettingStarted/images/13_AddFunction.jpg b/Demos/GettingStarted/images/13_AddFunction.jpg
diff --git a/Demos/GettingStarted/images/14_FunctionSuggestion.jpg b/Demos/GettingStarted/images/14_FunctionSuggestion.jpg
diff --git a/Demos/GettingStarted/images/15_CompleteCode.jpg b/Demos/GettingStarted/images/15_CompleteCode.jpg
diff --git a/Demos/GettingStarted/images/16_CreateList.jpg b/Demos/GettingStarted/images/16_CreateList.jpg
diff --git a/Demos/GettingStarted/images/17_Print.jpg b/Demos/GettingStarted/images/17_Print.jpg
diff --git a/Demos/GettingStarted/images/18_Start.jpg b/Demos/GettingStarted/images/18_Start.jpg
diff --git a/Demos/GettingStarted/images/19_Start.jpg b/Demos/GettingStarted/images/19_Start.jpg
diff --git a/Demos/GettingStarted/images/1_VSLaunching.jpg b/Demos/GettingStarted/images/1_VSLaunching.jpg
diff --git a/Demos/GettingStarted/images/20_ConfirmResult.jpg b/Demos/GettingStarted/images/20_ConfirmResult.jpg
diff --git a/Demos/GettingStarted/images/21_AddMatrix.jpg b/Demos/GettingStarted/images/21_AddMatrix.jpg
diff --git a/Demos/GettingStarted/images/22_AddMain.jpg b/Demos/GettingStarted/images/22_AddMain.jpg
diff --git a/Demos/GettingStarted/images/23_Completed.jpg b/Demos/GettingStarted/images/23_Completed.jpg
diff --git a/Demos/GettingStarted/images/24_PossibleError.jpg b/Demos/GettingStarted/images/24_PossibleError.jpg
diff --git a/Demos/GettingStarted/images/25_FixError.jpg b/Demos/GettingStarted/images/25_FixError.jpg
diff --git a/Demos/GettingStarted/images/26_FinalResult.jpg b/Demos/GettingStarted/images/26_FinalResult.jpg
diff --git a/Demos/GettingStarted/images/2_CreateProject.jpg b/Demos/GettingStarted/images/2_CreateProject.jpg
diff --git a/Demos/GettingStarted/images/3_ConsoleApp.jpg b/Demos/GettingStarted/images/3_ConsoleApp.jpg
diff --git a/Demos/GettingStarted/images/4_ProjectName.jpg b/Demos/GettingStarted/images/4_ProjectName.jpg
diff --git a/Demos/GettingStarted/images/5_CreateProject.jpg b/Demos/GettingStarted/images/5_CreateProject.jpg
diff --git a/Demos/GettingStarted/images/6_VSCodeStatus.jpg b/Demos/GettingStarted/images/6_VSCodeStatus.jpg
diff --git a/Demos/GettingStarted/images/7_CopilotLogo.jpg b/Demos/GettingStarted/images/7_CopilotLogo.jpg
diff --git a/Demos/GettingStarted/images/8_FirstCode.jpg b/Demos/GettingStarted/images/8_FirstCode.jpg
diff --git a/Demos/GettingStarted/images/9_CopilotSuggestion.jpg b/Demos/GettingStarted/images/9_CopilotSuggestion.jpg
diff --git a/README.md b/README.md
@@ -1,2 +1,34 @@
-# copilot-demo-github-dotnet
-Copilot demos containing .NET example for C# customers
+# Copilot Demos for C#, .NET through Visual Studio IDE
+
+![Microsoft Visual Studio ODE](./images/icon-vs.jpg)
+
+![.NET and C#](./images/dotnet.jpg)
+
+This contains a collection of demos for Copilot for **C#** and **.NET** through **Visual Studio IDE.** This is going to be useful for customers who are interested in using Copilot for C# and .NET and want to use Copilot to generate code through Visual Studio IDE.
+
+Note that Copilot extension for Visual Studio IDE is **only available for Windows**. If you are using Mac, you can use Copilot through VS Code.
+
+> GitHub Copilot is only available for VS Code, Visual Studio IDE for Microsoft Windows, NeoVim, and IntelliJ and GitHub Copilot is not available for Jupyter Notebooks.
+
+## Prerequisites
+
+All of demos here will require the following as minimum requirements. Some exercises might have more requirements. This assumes that you have a Windows environment.
+
+- [Visual Studio IDE](https://visualstudio.microsoft.com/downloads/) for Windows
+- [Copilot Extension for Visual Studio IDE](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). 
+
+[See this documentation on how to install Copilot extension for Visual Studio IDE](./CopilotExtensionVS)
+
+## Demos
+
+You want to start with basic one then jump to other ones.
+
+1. [Getting Started](Demos/GettingStarted/README.md)
+
+
+## Contribution
+
+If you want to contribute to this repo, please follow the [Contribution Guidelines](CONTRIBUTING.md).
+
+
+
diff --git a/images/dotnet.jpg b/images/dotnet.jpg
diff --git a/images/icon-vs.jpg b/images/icon-vs.jpg