For å holde kvaliteten høy mens vi utvikler Fleetwood har vi satt opp en del regler for hvordan utvikling skal gjøres.
Kjøreregler
For at vi skal ha høyest mulig kvalitet på både kode og guide, er det viktig at følgende kjøreregler følges.
- Vi følger en variant av Git Flow i prosjektet. Det betyr at branchene
masterogdeveloper låst for commits, og vi bruker feature branches som så merges inn. - Alle feature branches skal ha et beskrivende navn. Navnet kan enten være:
- Saksnummeret i devops:
feature/4242-feature-devops-name - Et beskrivende navn for hva som ligger i branchen:
fix/stenciljs-version-upgrade
- Saksnummeret i devops:
- Når en feature branch er merget inn til master, skal branchen slettes. Dette er for å unngå stale branches.
- For best kode kvalitet prøv å følge reglene:
- Alle enhetstester passerer (kjør
npm run testfør du sjekker inn) - Alle tilgjengelighetstester passerer (kjør
npm run testfør du sjekker inn) - Ingen feil er funnet i linting (kjør
npm run lintfør du sjekker inn)
- Alle enhetstester passerer (kjør
- Bruk alltid farger, fonter og verdier som ligger i variabler i stedet for å bruke hardkodede verdier.
Kodeverktøy
Prosjektet inneholder konfigurasjoner for EditorConfig Det er ønsket å bruke esline for å ha lik kode overalt.