Curriculum Review Committee: How to Contribute

The Team:

• Merge Magicians: @Simon and @Audrey
• Kanboard Maintainee: @Audrey
• Reviewees: (list staff here)

Curriculum Tools

The committee will utilize the organization kanban board, PRs, Review Commit Code of Conduct and Expectations Guide, and issues (TBD) 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 First Review: PR currently being reviewed. Refer to the assignee photo to see who the reviewer is.
• In Second Review: PR in the second review phase. If only one assignee is present on card, another reviewer needs to be assigned.
• Needs Magician Review: The last step before merge into Main. Simon and/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
  • Priority: High - Review and publish needed within 24-48 hours.
  • Priority: Medium - Review and publish needed within 7-10 days.
  • Priority: Low - No urgent need to review and publish within a month.
• 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 curriculum review Slack. Feel free to share questions, comments, concerns, and ideas you'd like to share with the committee.