Formatting updates for consistency

skills · May 31, 2023 · 75a1778 · 75a1778
1 parent 575a19e
commit 75a1778
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 11 deletions.
diff --git a/.github/steps/1-copilot-extension.md b/.github/steps/1-copilot-extension.md
@@ -1,3 +1,11 @@
+<!--
+  <<< Author notes: Step 1 >>>
+  Choose 3-5 steps for your course.
+  The first step is always the hardest, so pick something easy!
+  Link to docs.github.com for further explanations.
+  Encourage users to open new tabs for steps!
+-->
+
 ## Step 1: Leverage Codespaces with VS Code for Copilot
 
 _Welcome to " Develop With AI Powered Code Suggestions Using GitHub Copilot and VS Code"! :wave:_

diff --git a/.github/steps/2-skills-javascript.md b/.github/steps/2-skills-javascript.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 2 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 2: Seeing AI code suggestions in a Javascript file!
 
 _Nice work! :tada: You created a Codespace using a devcontainer file that installed Copilot!_

diff --git a/.github/steps/3-copilot-hub.md b/.github/steps/3-copilot-hub.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 3 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 3: View the GitHub Copilot tab with multiple suggestions
 
 _Nice work! You just used AI code suggestions within a Javascript file by using GitHub Copilot :sparkles:_

diff --git a/.github/steps/4-copilot-comment.md b/.github/steps/4-copilot-comment.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 4 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 4: Using comments to generate code with Copilot
 
 _Nicely done utilizing the Copilot tab!_ :partying_face:

diff --git a/.github/steps/X-finish.md b/.github/steps/X-finish.md
@@ -1,3 +1,8 @@
+<!--
+  <<< Author notes: Finish >>>
+  Review what we learned, ask for feedback, provide next steps.
+-->
+
 ## Finish
 
 _Congratulations friend, you've completed this course!_

diff --git a/.github/workflows/1-copilot-extension.yml b/.github/workflows/1-copilot-extension.yml
@@ -1,4 +1,4 @@
-name: Step 1, 1-Copilot Extension in a Codespace
+name: Step 1, Copilot Extension in a Codespace
 
 # This step triggers after push to main#devcontainer.json.
 # This workflow updates from step 1 to step 2.

diff --git a/.github/workflows/2-skills-javascript.yml b/.github/workflows/2-skills-javascript.yml
@@ -1,4 +1,4 @@
-name: Step 2, 2-Javascript function
+name: Step 2, Javascript function
 
 # This step triggers after push to main#skills.js.
 # This workflow updates from step 2 to step 3.

diff --git a/.github/workflows/3-copilot-hub.yml b/.github/workflows/3-copilot-hub.yml
@@ -1,4 +1,4 @@
-name: Step 3, 3-Copilot hub suggestion
+name: Step 3, Copilot hub suggestion
 
 # This step triggers after push to main#member.js.
 # This workflow updates from step 3 to step 4.

diff --git a/.github/workflows/4-copilot-comment.yml b/.github/workflows/4-copilot-comment.yml
@@ -1,4 +1,5 @@
-name: Step 4, 4-Add Copilot suggestion from comment
+name: Step 4, Add Copilot suggestion from comment
+
 # This step triggers after push to main#comments.js.
 # This step updates from step 3 to step 4.
 

diff --git a/README.md b/README.md
@@ -1,18 +1,33 @@
 <header>
 
-# Develop With AI Powered Code Suggestions Using GitHub Copilot and VS Code
+<!--
+  <<< Author notes: Course header >>>
+  Read <https://skills.github.com/quickstart> for more information about how to build courses using this template.
+  Include a 1280×640 image, course name in sentence case, and a concise description in emphasis.
+  In your repository settings: enable template repository, add your 1280×640 social image, auto delete head branches.
+  Next to "About", add description & tags; disable releases, packages, & environments.
+  Add your open source license, GitHub uses the MIT license.
+-->
+
+# Code with GitHub Copilot
 
-_GitHub Copilot can help you code by offering autocomplete-style suggestions._
+_GitHub Copilot can help you code by offering autocomplete-style suggestions right in VS Code and Codespaces._
 
 </header>
 
+<!--
+  <<< Author notes: Course start >>>
+  Include start button, a note about Actions minutes,
+  and tell the learner why they should take the course.
+-->
+
 GitHub Copilot can help you code by offering autocomplete-style suggestions. You can learn how GitHub Copilot works, and what to consider while using GitHub Copilot. GitHub Copilot analyzes the context in the file you are editing, as well as related files, and offers suggestions from within your text editor. GitHub Copilot is powered by OpenAI Codex, a new AI system created by OpenAI.
 
-- **Who this is for**: Developers, DevOps Engineers, Software development managers, Testers
-- **What you'll learn**: How to install Copilot into a Codespace, accept suggestions from code, accept suggestions from comments
-- **What you'll build**: Javascript files that will have code generated by Copilot AI for code and comment suggestions
-- **Prerequisites**: To use GitHub Copilot you must have an active GitHub Copilot subscription. Sign up for 60 days free [Copilot](https://github.com/settings/copilot)
-- **Timing**: This course can be completed in under an hour
+- **Who this is for**: Developers, DevOps Engineers, Software development managers, Testers.
+- **What you'll learn**: How to install Copilot into a Codespace, accept suggestions from code, accept suggestions from comments.
+- **What you'll build**: Javascript files that will have code generated by Copilot AI for code and comment suggestions.
+- **Prerequisites**: To use GitHub Copilot you must have an active GitHub Copilot subscription. Sign up for 60 days free [Copilot](https://github.com/settings/copilot).
+- **Timing**: This course can be completed in under an hour.
 
 ### How to start this course
 
@@ -38,6 +53,11 @@ GitHub Copilot can help you code by offering autocomplete-style suggestions. You
 
 <footer>
 
+<!--
+  <<< Author notes: Footer >>>
+  Add a link to get support, GitHub status page, code of conduct, license link.
+-->
+
 ---
 
 Get help: [Post in our discussion board](https://github.com/skills/.github/discussions) &bull; [Review the GitHub status page](https://www.githubstatus.com/)