The Wayback Machine - https://web.archive.org/web/20200129021943/https://lab.github.com/githubtraining/write-a-learning-lab-course

/

Write a Learning Lab course

Learn how to author your own Learning Lab course.

Join this course

GitHub Learning Lab is an integrated learning experience to help you learn how to use GitHub by using GitHub. Complete courses at your own pace on collaboration, workflow, and more.

Learning Lab helps people build real world skills through hands-on activities. This course streamlines the course building process, and gives you all the tools you need to help others learn.

Register for this course to get the starter files needed to build your Learning Lab course, or complete the course steps for a fully guided experience. If you choose to complete the course, you'll be able to:

  • Identify the structure of a Learning Lab course
  • Define a title and description for your course
  • Define a template repository
  • Create course steps
  • Create responses
  • Publish a course to GitHub Learning Lab
Steps to complete this course 16
  1. Welcome

    Decide whether to complete a guided course, or use boilerplate as is.

  2. Give your course a title

    Name your course so learners can find it.

  3. Add some descriptions to your course

    Give your course a description and tagline so learners can identify it.

  4. Approve the course metadata

    Approve the pull request containing the course's metadata.

  5. Point to the template repo

    Designate a template repository from which to clone.

  6. Give the learner's repo a name

    Designate a name for the repository when it is created for the learner.

  7. Approve the repo setup

    Approve the template repo information

  8. Create an issue using Learning Lab

    Use the `before` block to create an issue in the learner's repo.

  9. Create your first response

    Add content to the repo's first issue.

  10. Name your first step and give it a description

    Identify the first step so the learner knows what's expected.

  11. Trigger your first step with a GitHub event

    Add a pull_request.opened event.

  12. Validate a learner's pull request

    Add a gate to determine if the learner took the expected action.

  13. Use contextual information to validate

    Add options to the gate action.

  14. Respond to a learner's successful pull request

    Use a respond action when a learner opens their pull request.

  15. Add a README to your course

    Write a longform description for your course.

  16. Approve the steps

    Submit an approval for the steps pull request.

Ready to start learning?