Hvordan bidra - React ⭐
Vi er veldig happy med at du vurderer å bidra! Om du er usikker på noe som helst, ta kontakt. Eller bare send inn den buggen eller PRen uansett. Verste som skjer er at vi høflig ber deg endre på noe. Vi setter pris på alle hyggelige bidrag!
👋 Happy coding!
📝 Forutsetninger
- nodejs 18.19
- Kunnskap om Sass (SCSS) og CSS.
- Forståelse av BEM-navnekonvensjoner som designsystemet følger.
- Noen skal ha designet komponenten i Figma (Krever innlogging og tilgang).
Aller først må du konfigurere git-hooks slik at scripts kjøres ved commits, som for eksempel et script som kopierer innhold fra readme og contributing til dokumentasjonsnettsiden.
Sett opp git hooks:
git config core.hooksPath scripts/git-hooks
Lerna
Punkt er et monorepo og bruker lerna. Det betyr at alle kommandoer kjører
fra repoets rot, og ikke i subrepoene.
Et utdrag fra rot-package.json viser noen scripts som er satt opp for å forenkle utvikling i dette subrepoet:
"scripts": {
"build-react": "npx lerna run build --scope=@oslokommune/punkt-react",
"build-react-app": "npx lerna run build-app --scope=@oslokommune/punkt-react",
"dev-react": "npx lerna run dev --scope=@oslokommune/punkt-react",
}
Figma
Sørg for at noen har designet komponenten i Figma (Krever innlogging og tilgang).
🛠️ Gjør arbeidet
Kod som om livet ditt avhenger av det, men ha det gøy mens du gjør det!
🤝 Lag PR
Når du er klar for en PR skriv din GitHub-message som sier hva som er gjort, og evt issue nummer.
Vi bruker Conventional Commits for å beskrive commits gjennom noen regler. Ingen fare om du ikke følger den, vi tar en gjennomgang og evt justerer 😎.
fix(react): #NR Rett feil på alert-komponenten # med issuenummer
fix(react): Rett feil på alert-komponenten # patcher en bug i koden (patch i Semantic Versioning)
feat(react): Legg til funksjonalitet # ny funksjonalitet i koden (minor i Semantic Versioning)
feat(react)!: Legg til funksjonalitet og endre eksisterende # breaking change i koden (major i Semantic Versioning)
docs: Endre dokumentasjon # Endring i dokumentasjon
🔢 Publisering og versjonering
Vi tar oss av publisering av pakken og versjonering.
Punkt bruker Semantic Versioning 2.0.0 for versjonering av pakkene.