Ønsker du å bidra med innholdsproduksjon kan det enkelt gjøres ved å:
- Lag en fork av dette repoet.
- Gjør endringer/lag innhold.
- Legg inn en pull request her.
- Følg retningslinjene som er beskrevet under
TODO: Lage videotutorial?
TODO: Generell intro om hvorfor vi har retningslinjer...
Retningslinjene er delt inn i tre hovedområder:
Alle fagstoffsider skal oppfylle kravene som er gitt nedenfor.
- Alle fagstoffsider skal implementeres som Jupyter notebooks
- Alle fagstoffsideer skal merkes med en Creative Commons-lisens
- Foretrukket lisens er CC BY-SA
Første celle i notebook-en skal ha følgende innhold:
- Tittel på notebook-en
- Linjen etter tittelen skal inneholde lisensinformasjon og navn på opphavsmenn
- Fagteksten skal starte med en kort ingress som gir en introduksjon til fagstoffet som skal behandles.
- Sammen med ingressen bør det være et illustrerende bilde eller figur. Bildet skal være ca. 200 piksler i bredden, og skal flyte til høyre for ingressen.
- Etter ingressen skal det stå opplysninger om relevante læreplanmål
Andre celle i notebook-en skal ha følgende innhold:
- Fagtekst
- Matematikk som er typesatt med LaTeX (der hvor det er aktuelt)
- En eller flere figurer som illustrerer fagteksten
Tredje celle i notebook-en skal ha følgende innhold:
- Python-kode
- Koden bør ligge så nært opp til standarden PEP-8 som mulig
Standarden for tredje og fjerde celle gjentas så mange ganger som nødvendig gjennom resten av notebook-en (veksler mellom fagtekst og programkode).
Nest siste celle i notebook-en skal ha følgende innhold:
- En oppsummering av fagstoffet som er behandlet
Siste celle i notebook-en skal ha følgende innhold:
- Oppgaver
- Større (tidkrevende) oppgaver skal implementeres som egne "Prosjektoppgaver"
TODO
TODO