Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.88 KB

Utvikling av nye eller eksisterende løsninger

TL;DR

Vi bruker yarn for pakkeversjonering. Har du ikke yarn? npm i -g yarn

git clone git@github.com:navikt/Designsystemet.git
cd Designsystemet
yarn install
yarn boot

// Storybook
yarn storybook

// Nettside
yarn dev

Storybook: http://localhost:6006

Nettside: http://localhost:3000

Utviklingsmiljø

Vi bruker storybook https://storybook.js.org/ for utvikling av nye komponenter. Skriv stories for komponentene man vil teste (hvordan skrive storybook stories)

Utvikling av nye komponenter

Det er ikke satt opp en template for nye komponenter, men vi følger til dels en mal.

@navikt/pakkenavn
└─ src          # Komponenter
   ├─ index.ts  # Alle exports
   └─ pakkenavn
      ├─ index.ts       # Alle exports fra komponent
      ├─ komponent.tsx  # Komponentkode
      └─ komponent.stories.tsx # Stories

Dokumentasjon

Dokumentasjon ang komponentter finner man på aksel.nav.no. Hvis man ønsker å skrive noe dokumentasjon selv gjør vi det via CMS et Sanity. Kode-eksempler blir skrevet lokalt i (https://github.com/navikt/aksel-website/tree/main/website/pages/eksempler)[aksel-website repo]

Versjonering av pakker

Vi bruker changeset for versionering av pakker. Se README for mer informasjon.

Kodekvalitet og testing

Noen komponenter og løsninger blir testet med jest + react-testing-library.

  • Commit: Kjører prettier på endrede filer + linter
  • Ved PR: Kjører tester, linter og visuell regresjonstester

Oppdatere Aksel.nav.no

Push til master pusher endringer til prod

Push til next pusher endringer til aksel.dev.nav.no