Home

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

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

The Team

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

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.

• Unit 1: https://github.com/Ada-Developers-Academy/core-unit-1/wiki/_new
• Unit 2 & 3 (coming soon)

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.

Primary Committee Tools

• Project Board
• Pull Requests
• Issues
• Review Commit Code of Conduct and Expectations Guide
• Slack

Writing and Markdown Guides

• Writing Style Guide
• Learn Markdown
• Writing Copy Pastes

Project Board

The project 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. We would love for reviewers to add some content suggestions as comments.
• Ready for Review: PRs 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 merging into Main. Simon or Audrey will discuss reviews and/or merge in changes.
• In Main: PRs merged into main

How to Contribute

Committee members will edit PRs containing lessons. Members are free to edit towards their interests and according to their time commitment.

There are 3 roles reviewers can take for each PR:

• Editor: Proofreads, expands on explanations, wordsmith, sensitivity/respects, and honors Adies. References the Writing and Markdown guides often.
• Question curators: Creates questions based on learning goals and content in the lesson. Great for members short on time but looking to make a great impact. References the Learn Markdown often.
• Visual curators: Great for the visually inclined, dev Twitter addicts, lovers of code snippets, designs, diagrams, or has a relevant picture/meme saved for YEARS that they're excited to share. Uses citation format to credit sources outside of Ada.

Note: Roles are NOT restrictive, a member can take on 1 or all roles for a PR as long as they assign themselves to the relevant PR and issues.

To start reviewing curriculum:

• Step 1: Browse the cards in the project board and issues, and choose your role.

  • Editors: Go to Project board and look for PRs in ‘Ready for Reviews’, ‘In First Review’, 'In Second Review' and assign yourself under ‘Assignees’.
    • If you'd like to be the first reviewer of a PR, move the card from 'Ready for Review' to 'In First Review'.
    • If you'd like to be the second reviewer of a PR, move a card from 'In First Review' to 'In Second Review'.
  • Question Curators: Look in Issues for creating questions for a lesson and assign yourself to this card.
  • Visual Curators: Look in Issues for adding Visuals for a lesson and assign yourself to this card.

• Step 2: Review Work

  • Editors: Make as many comments and suggestions as you’d like. Once you are finished, please add a comment to the batch review and mark as:
    • ‘Approved’ (default) - the lesson looks mostly great and ready for Simon and Audrey to review.
    • ‘Request Changes’ - If the lesson needs a complete rewrite and further discussion is required, Simon and I will take a look.
  • Question Curators: Add questions as a ‘comment’ in pull request batch review. Move card from ‘In Development’ to ‘Ready for Magician Review’.
  • Visual Curators: Add visuals as a ‘comment’ in PR batch review. If a visual is from an external source see citation format below. Move card from ‘In Development’ to ‘Ready for Magician Review’.

Important Note: PRs must be approved for changes by 2 reviewers before moving onto the next step, review by Simon or Audrey

Visuals Guide

This guide has been migrated to Confluence. This version is no longer maintained.

All visuals must follow Web Accessibility Principles and use inline citation. Lesson visuals can be:

• Diagrams
  • Self-made diagrams are encouraged
  • Color is highly encouraged, so color combinations follow web accessibility principles. You can use the contrast checker tool to check if your color combinations offer enough contrast for readability.
• Images/Memes
  • Can be added via pull request to the /images folder
  • Keep widths and height of images to be under 400px.
• Gifs
  • Must not have too many moving parts or text next to moving parts
• Videos
  • Embed using iframe: <iframe src="url" title="description">
  • Must have the ability to stop or pause
  • Subtitles highly encouraged

Citation Format

Please credit visuals to its source using inline citation and alt text in Markdown or HTML.

Markdown

(source: [short description](linktoresource))

HTML

<img src="link" alt="short description of photo" width="custom size" height="custom size" />

Example:

(source: wikipedia)