Skip to content
Audrey Andoy edited this page Dec 1, 2020 · 11 revisions

Welcome to Ada's Core-Unit-1 Wiki!

This repo is where Unit 1 of Ada's new Python curriculum will live.

The Team:

The Curriculum

The new Python curriculum will be consumed by students through the Learn platform and will be split into 3 different units, each having its own repository.

Units are made up of several topics which are broken down further into lessons. Each topic contains one or more lessons that dive deeper into different parts of the topic. For example, functions is split into 3 different lessons: intro to functions, invoking functions, and defining functions.

Simon will produce PRs based on a topic. Reviewees will then produce batch reviews on lessons inside of PRs.

Curriculum Tools

The committee will utilize this repository's project board, PRs, Review Commit Code of Conduct and Expectations Guide, and issues to organize and claim tasks. Each PR will need to be reviewed by at least two reviewees.

Kanban Board

The Kanban board displays all work contributed to curriculum development that will be managed by Audrey. It is split into 5 different columns:

  • In Development: describes lessons in PR that are still in the writing/brainstorming stage that could use a suggestion or two.
  • Ready for Review: PR consisting of lessons ready to be reviewed.
  • In Review: PR currently being reviewed. Refer to the assignee photo to see who the reviewer is. In order to move onto the next step, two reviewers must approve the PR for changes to be merged.
  • Needs Magician Review: The last step before merge into Main. Simon or Audrey will discuss reviews and/or merge in changes.
  • In Main: PRs merged into main

Pull Request Labels

  • Needs Learn
    • Each lesson will be published in Learn and requires Learn markdown for callouts, headings, challenges, etc.
  • Needs Visual
    • The goal for each lesson is to provide a relevant visual (video, photo, meme, etc.) to aid in students learning.
  • Priority: ranks PRs by its urgency to meet a deadline
  • Length: Measures the time and effort it may take to review PRs.
    • Length: Long - Long PRs consist of longer lessons. These can benefit from having 3 reviewers.
    • Length: Medium - Medium length PRs. 2 reviewers are sufficient enough.
    • Length: Short - Short lessons. Busy reviewers may benefit from tackling these PRs during busy weeks.

How to Contribute

To start reviewing curriculum:

  1. First check the organization kanban board to check which PR's are available in the In first review or In second review columns.
  2. Select a card, move it to 'In first review' (this may change depending on permissions of committee members). - Feel free to spark conversation in comments about the content within a lesson. Audrey and Simon will respond once PR is in 'Magician Review'.
  3. Once finished with batch review, move Kanban card to 'In Second Review' to notify other committee members that you are finished.
  4. Keep in touch in the C15 curriculum review slack. Feel free to share questions, comments, concerns, and ideas you'd like to share with the committee.
Clone this wiki locally