From 1062d75d7b14bf519b1a90c2fa3fb0c5941f23a9 Mon Sep 17 00:00:00 2001
From: Kevin Heis <heiskr@users.noreply.github.com>
Date: Tue, 30 May 2023 21:50:22 -0700
Subject: [PATCH] Formatting updates for consistency

---
 .github/steps/1-create-beta-release.md      |  8 ++++++-
 .github/steps/2-feature-added-to-release.md |  6 +++++-
 .github/steps/3-release-pr-opened.md        |  6 +++++-
 .github/steps/4-release-notes-and-merge.md  |  6 +++++-
 .github/steps/5-finalize-release.md         |  6 +++++-
 .github/steps/6-commit-hotfix.md            |  6 +++++-
 .github/steps/7-create-hotfix-release.md    |  6 +++++-
 .github/steps/X-finish.md                   |  5 +++++
 README.md                                   | 24 ++++++++++++++++-----
 9 files changed, 61 insertions(+), 12 deletions(-)

diff --git a/.github/steps/1-create-beta-release.md b/.github/steps/1-create-beta-release.md
index dc5b44d..ef14f64 100644
--- a/.github/steps/1-create-beta-release.md
+++ b/.github/steps/1-create-beta-release.md
@@ -1,4 +1,10 @@
-<!--Step 1-->
+<!--
+  <<< 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: Create a beta release
 
diff --git a/.github/steps/2-feature-added-to-release.md b/.github/steps/2-feature-added-to-release.md
index 0c7b8df..bdebafc 100644
--- a/.github/steps/2-feature-added-to-release.md
+++ b/.github/steps/2-feature-added-to-release.md
@@ -1,4 +1,8 @@
-<!--Step 2-->
+<!--
+  <<< Author notes: Step 2 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
 
 ## Step 2: Add a new feature to the release branch
 
diff --git a/.github/steps/3-release-pr-opened.md b/.github/steps/3-release-pr-opened.md
index bdeb420..77827c6 100644
--- a/.github/steps/3-release-pr-opened.md
+++ b/.github/steps/3-release-pr-opened.md
@@ -1,4 +1,8 @@
-<!--Step 3-->
+<!--
+  <<< Author notes: Step 3 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
 
 ## Step 3: Open a release pull request
 
diff --git a/.github/steps/4-release-notes-and-merge.md b/.github/steps/4-release-notes-and-merge.md
index 263adf8..0f8f516 100644
--- a/.github/steps/4-release-notes-and-merge.md
+++ b/.github/steps/4-release-notes-and-merge.md
@@ -1,4 +1,8 @@
-<!--Step 4-->
+<!--
+  <<< Author notes: Step 4 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
 
 ## Step 4: Generate release notes and merge
 
diff --git a/.github/steps/5-finalize-release.md b/.github/steps/5-finalize-release.md
index 01bd497..62fdb39 100644
--- a/.github/steps/5-finalize-release.md
+++ b/.github/steps/5-finalize-release.md
@@ -1,4 +1,8 @@
-<!--Step 5-->
+<!--
+  <<< Author notes: Step 5 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
 
 ## Step 5: Finalize the release
 
diff --git a/.github/steps/6-commit-hotfix.md b/.github/steps/6-commit-hotfix.md
index f9bcdaa..fae0005 100644
--- a/.github/steps/6-commit-hotfix.md
+++ b/.github/steps/6-commit-hotfix.md
@@ -1,4 +1,8 @@
-<!--Step 6-->
+<!--
+  <<< Author notes: Step 6 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
 
 ## Step 6: Commit a hotfix to the release
 
diff --git a/.github/steps/7-create-hotfix-release.md b/.github/steps/7-create-hotfix-release.md
index 51a7dd1..6c1adfc 100644
--- a/.github/steps/7-create-hotfix-release.md
+++ b/.github/steps/7-create-hotfix-release.md
@@ -1,4 +1,8 @@
-<!--Step 7-->
+<!--
+  <<< Author notes: Step 7 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
 
 ## Step 7: Create release v1.0.1
 
diff --git a/.github/steps/X-finish.md b/.github/steps/X-finish.md
index 70c320a..5c3adb7 100644
--- 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
 
 <img src="https://octodex.github.com/images/snowtocat_final.jpg" alt=celebrate width=300 align=right>
diff --git a/README.md b/README.md
index 5ab4974..4855e89 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,12 @@
 <header>
 
 <!--
-    The step and endstep markers will cause this
-    introduction content to be hidden once the
-    repository is created off the template
+  <<< 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.
 -->
 
 # Create a release based workflow
@@ -12,6 +15,12 @@ _Create a release based workflow that is built on the foundations of the GitHub
 
 </header>
 
+<!--
+  <<< Author notes: Course start >>>
+  Include start button, a note about Actions minutes,
+  and tell the learner why they should take the course.
+-->
+
 ## Welcome
 
 Create a release based workflow that is built on the foundations of the [GitHub flow](https://guides.github.com/introduction/flow/). When your team uses a release-based workflow, GitHub makes it easy to collaborate with deployable iterations of your project that you can package and make available for a wider audience to download and use.
@@ -58,10 +67,15 @@ In this course, you will:
 
 <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) • [Review the GitHub status page](https://www.githubstatus.com/)
+Get help: [Post in our discussion board](https://github.com/skills/.github/discussions) &bull; [Review the GitHub status page](https://www.githubstatus.com/)
 
-© 2022 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit)
+&copy; 2023 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
 
 </footer>