workflows

Lesson Plans

In this module you will focus on the fundamental workflows you need as a developer working alone and in a group. This includes using VSCode, the command line, formatting & linting code, using Git and GitHub.

You will practice these skills using the template-markdown repository.

Before the class

• Make sure Node.js is installed on your computer
• Practice navigating directories using the Command Line Interface
• Play around a little with learngitbranching
• Take a look through First Day on GitHub
• Begin watching Git and GitHub for Poets
• Setting up git & GitHub Odin Project
• Practice using VSCode to:
  • open a project
  • open, edit and save files
  • use the built-in terminal
  • run NPM commands

During the class

Before Break

All Together

• 10 min: Q/A and review of previous materials
• 40 minutes: A coach shares their screen and does a guided walk through the template-markdown repository:
  • what is git? and github?
  • how to clone a repository from github?
  • what is NPM?
  • how do you install NPM dependencies?
  • how can you find NPM scripts in a package.json file?
  • what is linting? and formatting?
• 60 min: in small groups, practice writing great Markdown using code quality checks, each person should try on their own computer:
  • Clone the template-markdown repository
  • Open it in VSCode
  • Install dependencies
  • Write some Markdown in the README and practice adding new files
  • Practice using the formatting, linting and spell-check scripts to improve your Markdown
• 10 min: All together, each group quickly presents:
  • what went well
  • what went less well
  • lessons learned

After Break

all together

• 20 min: Introduction to collaborative development
• 20 min: Form small random groups and split up:
  • Read through the Group Introduction deliverable and make sure everyone understand the project
  • Generate a repository for each group in the class organization using the template-markdown repository
• 40 min: In small groups, prepare for the week’s deliverable:
  • Set up your group’s repository:
    • The Basics
      • Use the name your team decided on
      • Turn on GitHub Pages and set your live URL as the Website in your repository’s About section
      • Turn on Discussions in your repository
    • Collaboration Settings
      • Add everyone in your team as a contributor with Admin access
      • Require a code review for PRs to main (owanateamachree, github docs)
        • You will need to type main or master into the Branch name pattern input box (depending on which on what your repo’s default branch is named)
        • Select Dismiss stale pull request approvals when new commits are pushed
  • Create your group’s deliverable issue and place it on the class project board
  • Set up your group repo’s project board
  • Make sure everyone is ready for the week
• 10 min: Come back together for a short check-in from each group and Q/A with the coaches

After the class

• Complete the Group Introduction Repo deliverable
• Complete the Student Bio PR deliverable
• Read over the learning objectives for chapters 0, 1 & 2
• Work your way through the exercises for these chapters (if there are any in the folders)
• Read over the learning objectives for chapter 3
• Work your way through the exercises for chapter 3 (if there are any in the folder)
• Study the Suggested Study for these chapters
• Study the Suggested Study for this chapter

This site is open source. Improve this page.