Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 14.9 KB

File metadata and controls

128 lines (93 loc) · 14.9 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. Volunteer for the Tech Education team to teach in our classes, or contribute in a number of other ways. You can also volunteer remotely.

Volunteer with CYF

Who runs this?

Our Tech Education volunteers teach in our classes. All Tech Ed volunteers can, and do, develop content for the curriculum, and they are encouraged to experiment to see what works. Our trainees also notice problems, and propose or implement solutions!

The Curriculum Team is a group of long term volunteers who are responsible for the overall direction of the curriculum. They decide the strategy and accept new content into the core. Once a Tech Ed volunteer has sufficiently tried out their material, they can propose that it be adopted into the main curriculum, and the Curriculum Team will make the ultimate decision. See more info on contributing new content below.

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

About our 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

Pedagogy

We broadly use the Teach Tech Together pedagogical framework, in a flipped classroom style.

How to contribute

Contributions to the curriculum are always welcome. Help in navigating teh directory structure and instructions for local testing can be found in the contribution guidelines pages of our curriculum.

Site Search

PageFind runs the search. https://pagefind.app/ It's in the build command on Netlify hugo && npx pagefind --source "public" If you need to develop on this locally, run:

rm -rf public &&
npm run build:dev &&
npx pagefind --site "public" --serve

And go to http://localhost:1414/ to see the PageFind-served site with search enabled; but there is no hot reload. You can run hugo on http://localhost:1313/ at the same time.

Checklist before raising a PR

Please check the following before raising a PR. Unless you have been given permissions to push to the code your future repo you will have to create a fork of the repo and then raise a PR from that to the main repo. You will also not be able to add reviewers yourself unless you have been given permission, but you can mention people in the PR description to bring it to their attention.

If you are working on a GitHub issue please mention the reference in the PR, but if it is a small improvement it does not need one.

Deploy preview

When you raise a PR, Netlify will automatically try and deploy your branch and give you a custom URL so you can view a preview of your changes and anyone reviewing your PR can see the preview without needing to run the branch locally.

However, if you do not have permissions to push to the CodeYourFuture repo and are creating a PR from a fork of the review, someone with the correct permissions will have to approve the Netlify build. Please ask in the #cyf-curriculum channel in slack to get the build approved. If you have push permissions then the build will happen automatically.

As this repo contains multiple sites, when you create a PR it will create a different Netlify build for each site. Netlify also runs Lighthouse and creates a report on performance, accessibility, SEO and best practices so you can see how your branch performs.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


nbogie

📖

Stéphanie Krus

️️️️♿️

Chris Owen

📖

Mike Hayden

🖋

Alasdair Smith

🖋 📖

Jonathan Sharpe

🖋 🚇

rc-pm

📖

Nick Holdsworth

🖋

Tim Hamrouge

🖋

MitchLloyd

👀 ⚠️ 💻

gregdyke

🚇 ⚠️ 🖋 💻

Lucy Zidour

🖋 💻 👀

Alessandro

🖋 💻

Antigoni Makri

🖋 💻

Francesc Rosas

🖋

Sam Martin

🖋 💻

jcholyhead

🖋 💻

Mark Farmiloe

🖋 💻

Máté Szendrő

🖋 💻

Matthew Craven

🐛

Daniel Carter

🐛

Coung

🖋 💻

Lana-Franks-Code

🐛

Gintaras

🐛

rickscode

🐛

Claire Bickley

🖋

Jack Franklin

🐛

Sanyia Saidova

🖋 💻

Jo

🖋 💻

This project follows the all-contributors specification. Contributions of any kind welcome!