Jøkul er et fellesprosjekt for alle i Fremtind. Det vil si at det også er ditt. Om du oppdager en feil, eller har et ønske om å gjøre en endring eller legge noe til, så er det aller beste om du sørger for å få det gjort. Jøkul-teamet er her for å hjelpe deg med det praktiske.
Før du begynner bør du ha lest Hvordan endre Jøkul. Guiden der forklarer den anbefalte fremgangsmåten for å foreslå en endring. Kort fortalt går det ut på å snakke med folk! 😄 Guiden forklarer hvor og hvordan vi pleier å samarbeide, noen tips og triks for å få til en god diskusjon, og veien videre når vi har blitt enige om noe.
Det er skrevet en innføring for utviklere her som hjelper deg med å komme i gang med utvikling for Jøkul, ikke bare med Jøkul.
Vi har blitt enige om noen minimumskrav for dokumentasjon av komponenter i portalen. Disse er:
- Ingress med kort beskrivelse av komponenten
- Første eksempel synlig uten å scrolle
- Relevante eksempler på riktig og feil bruk
- Live kodeeksempel (oppdateres med valgte egenskaper)
- React-props for komponenten(e) i bunnen
I tillegg er det noen føringer for dokumentasjon i hver pakke sin README:
- Lenke direkte til dokumentasjonen for komponenten i portalen
- Beskrive hvordan installere pakken, med eksempelkommandoer for copy+paste
- Eksempel på
importav React- og CSS-kode for copy+paste
Sist, men ikke minst – om du gjør en breaking change må det dokumenteres i pakken sin MIGRATION hvordan man migrerer fra forrige versjon til den nye:
- Opprett MIGRATION.md om den ikke finnes, i samme mappe som README
- Den nye majorversjonen skal ha en egen heading. Bruk dagens versjon + 1.
- Beskriv alle steg som må tas dersom man skal oppgradere til den nye versjonen
- Bruk veldig gjerne
diff-eksempler som demonstrerer endringen visuelt. Se f. eks radio-button-react/MIGRATION.md.