Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 999 Bytes

CONTRIBUTION.md

File metadata and controls

34 lines (24 loc) · 999 Bytes

Contribution

Exercise structure

The exercise should have the following sections:

  • Learning goals (bullet points on what the student should learn)
  • Introduction (cleartext description of the exercise)
  • Exercise (Step-by-step instructions on how to solve the exercise)
  • Extras and wrap-up (optional)

When creating a new exercise, you should use the exercise template as a starting point.

Best practices

Hints

Use 💡 :bulb: to indicate a hint to the exercise.

Dealing with text rich content

When ever you think there is too much text, but that it is necessary, please use the details tag to make the text toggleable, by clicking the arrow:

A Hint It helps reducing the amount of word overload that we sometimes write

The code to make this happen is the following:

<details>
    <summary>Hint</summary>
        All markdown in here is hidden in an expandable field
</details>