Hopp til innhold

Hvordan gjøre endringer i Jøkul

Det er mange som bruker designsystemet vårt. Noen er godt kjent med det, andre har vært litt innom det, mens noen ikke kjenner til det i det hele tatt. For å tilrettelegge for godt samarbeid, foregår all utvikling knyttet til Jøkul på GitHub. Hvis ikke du er kjent med GitHub fra før av, anbefaler vi at du tar kurset vårt.

Vet du allerede hvor du skal? Her er snarveiene.

Åpne en diskusjonStart et issue

Før du begynner

Sjansen for at behovet ditt har felles-interesser med andre er ganske stor, siden vi er så mange. Det er mulig behovet ditt allerede har blitt løst, eller kan løses med eksisterende komponenter. Derfor er det et par ting som er lurt å spørre seg selv om før du melder inn et nytt forslag:

  • Ligger det noe i komponentbiblioteket som likner?
  • Vet du om andre team har samme behov som deg?
  • Har du tatt en prat med noen fra Designsystem-teamet, eller forumet?

Tips til et godt beskrevet forslag

Jo mer kontekst du kan dele, jo bedre. Det meste som lanseres i Jøkul er et produkt av godt samarbeid. Da er det viktig å kommunisere godt hva du ønsker. Vi har et par tips til hva du bør tenke på:

  • Start for deg selv. Skriv ned kort og enkelt det du tenker, i et par setninger for deg selv, inkluder litt om potensialet og hvilken utfordring du står ovenfor.
  • Lag en skisse! De fleste av oss er visuelle mennesker, lager du en skisse av det du ønsker deg, er det veldig mye greiere å forholde seg til.
  • Oppsummer bidraget ditt og del det på GitHub, så kan du trekke på kompetansen til hele design- og teknologimiljøet vårt.
  • Ta opp forslaget ditt på Designsystem-forum (hver tirsdag klokken 14.00), hvis du opplever lite engasjement.

Unntak er selvfølgelig en greie

Av og til oppdager man bugs, feil, eller veldig åpenbare ting som bare rett og slett burde fikses, da burde det som regel gå ganske greit å hoppe bukk over de fleste stegene og melder inn et issue direkte, så lenge du beskriver feilen/bug’en nogenlunde godt, og sjekker med noen andre.

Del behovet ditt

Nesten alt kan bli dobbelt så bra, bare du deler det med et par andre. Det meste som lanseres i Jøkul, starter som en god diskusjon blant likesinnede. Vi deler saker inn i to kategorier, stort sett; diskusjoner, og issues. Hvis du ikke kjenner disse begrepene fra før, anbefaler vi at du tar GitHub kurset vårt.

Hva er forskjellen mellom diskusjoner or issues?

  • En god tommelfingerregel for når et bidrag burde starte som en diskusjon kan være at du ønsker flere innspill fra andre, eller at du har et spørsmål eller en utfordring du rett og slett bare trenger å lufte bredt.
  • Du vet som regel at bidraget ditt er godt nok detaljert til å bli et issue når det er lett å estimere hvor lang tid det tar å lansere bidraget, og det kan knyttes til et behov i et aktivt prosjekt ute hos leveranseteamene.

PS: Hvis du tør å delegere ansvaret for oppgaven til deg selv, så er den som regel godt nok beskrevet ;)

Klar for å lansere? Huskelista hjelper deg.

Hvordan vet du at bidraget ditt er godt nok til å lanseres? Det korte svaret er at det kommer litt an på. Men hovedregelen er at du som bruker av Jøkul, er ansvarlig for å bestemme hva som kommer ut. Når det er sagt, så kan det være greit med en liten huskeliste og en kameratsjekk underveis. Vi har noen forslag til hva som er lurt å tenke på før man lanserer et nytt bidrag:

For alle

  • Bidraget burde være dokumentert i portalen med formål, et interaktivteksempel, prinsipper for riktig og feil bruk, eksempel på live kode og tilgjengelige react props.
  • De som er assignet til issuet er ansvarlige for at bidraget er godt dokumentert i sine respektive fagområder, før det lanseres. Portalen for felles dokumentasjon, Figma for design og GitHub for kode.

For designere

  • Bidraget burde være ferdigstilt i en egen branch i Figma-biblioteket, og være sjekket av med minst en annen designer før det blir merget inn i biblioteket.

For utviklere

  • Koden skal være dokumentert på GitHub, ha passert nødvendige tester og blitt godkjent av andre utviklere i en pull-request.

Bonuspoeng

  • Skriv noen kontrollspørsmål for bruk av komponenten
  • Legg til et par eksempler på bruk ute i leveranseteamene
  • Krydre med lenker til andre relevante relaterte komponenter

Vanskelig?

Hvis du ikke vet hvor du skal starte, kan det være en gode ide og stille et spørsmål på GitHub. I tillegg har vi gode ambassadører på plass som kan sørge for at du godt kommer i gang. Hvis du står helt fast, ta kontakt med Jøkul-teamet direkte eller via Support Designsystem, hvis du skulle ha noen spørsmål.