Skip to content

Latest commit

 

History

History
97 lines (58 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

97 lines (58 loc) · 3.96 KB

Contribution Guide

Welcome to the CYF Curriculum

We are a volunteer-led community of tech professionals, and we teach people to code for free. We are majority-minority, we welcome everyone, and we welcome you.

This curriculum compiles narratives and activities developed by hundreds of people all over the world. You are invited to join us.

https://codeyourfuture.io/

Who runs this?

The Global Syllabus Team is a group of long term CYF volunteers who are responsible for the overall direction of the curriculum. All Tech Ed volunteers can, and do, develop content for the curriculum, but the Global Syllabus Team decide the strategy and accept new content into the core.

This team is led by the Director of Education, currently Sally McGrath. We meet every two weeks to discuss the curriculum and make decisions. The agenda is posted in the CYF Slack channel #cyf-syllabus-tech and the minutes are posted on this website. If you'd like to come and talk to us, please do!

What content?

Our content is:

  • practical
  • written in simple English at a maximum of CEFR B2
  • free

Our content is not:

  • a textbook
  • a reference manual
  • a collection of tutorials

How to contribute

Propose a new narrative or activity

We adopt tested content into the main curriculum, so develop and try out your material first! Come to class, try it, and get feedback from the community. Come talk in #cyf-syllabus-tech on Slack and iterate on your session.

  1. Develop your narrative or activity in a CYF repo.
  2. If you're recording a video, upload it to YouTube and make it public.
  3. Use your material and iterate on it with trainees.
  4. When you're ready to propose adoption, open a PR to this repo, and choose the adoption PR template.
  5. The Global Tech Ed team will consider your proposal and give you feedback.

We like to experiment. If you have an idea, try it out and let us know how it goes! Keep your experiments small and test them early. (If you want to try something big, like a new module, come talk to us first.)

Our curriculum threads a coherent line through all of this activity, so whatever worlds we explore, we can all come back here and find out what to do next.

Most content we develop and use with classes will not be adopted into the core curriculum -- that's ok! We want to be free to experiment.

Pedagogy

We use the Teach Tech Together pedagogical framework.


https://github.com/CodeYourFuture/CYF-Coursework-Template

COURSEWORK NAME

Replace this readme with the requirements for your coursework

Learning Objectives

- [ ] Use the [Teach Tech Together](https://teachtogether.tech/en/index.html#s:process-objectives) guide to construct your objectives
- [ ] Limit the objectives to 3-5 items
- [ ] Write objectives you can measure

Requirements

Explain the requirements of the coursework. You might want to talk about goals here. You might want to use formal specifications like Given/When/Then. It's ok for requirements to be in different formats. We want trainees to learn to interpret requirements in many settings and expressions.

Acceptance Criteria

  • I have provided clear success criteria
  • These might be related to the objectives and the requirements
  • I have given some simple, clear ways for trainees to evaluate their work
  • I have run Lighthouse and my Accessibility score is 100

How to join CYF Tech Ed

Volunteer with CYF

Bugs

If you spot a bug, please let us know by creating an issue or opening a PR with the fix. Bug fixes are super welcome!

As this front end composes many different repos, please open an issue in the repo where you found the bug. If you're not sure, open an issue in this main repo.

(If the content is pulled from another repo, there's a link next to the heading -- follow that link to the source repo and open an issue there.)