Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Commit 891b001

Browse files
committed
wrap best practices in a collapsible block
1 parent 474c4d8 commit 891b001

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

responses/06.0_add-first-step.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@ Let's now dive into the `steps:`. This block is composed of [:book: steps](https
55

66
Each step maps directly to something that the user will do. User interaction on GitHub triggers the step, and Learning Lab responds. The user interaction could be creating a pull request, closing an issue, or editing a file. When designing a course, it's important to plan for the user interactions to reflect what you want them to learn.
77

8+
<details><summary>Best practices for steps</summary>
9+
810
For example, you _could_ write a lot of text and have the user close the issue when they're done. But, unless your text was telling them how to close an issue, that reaction doesn't make sense. Try to find a way to have the user demonstrate their knowledge, like by committing a function to a branch. Let the user _show_ they understand to trigger the next step.
911

12+
See [:book: best practices](https://github.github.com/learning-lab-equipment/#/3-5-responses?id=best-practices) in the Learning Lab docs for more suggestions.
13+
</details>
14+
1015
## Step 7: Naming our first step
1116

1217
Let's name our first step. We will give it a **title** and a **description**. These will be shown on Learning Lab, and they help course authors stay organized in the `config.yml` file.

0 commit comments

Comments
 (0)