đš Bidra med kod
Den hÀr guiden beskriver hur du bygger och bidrar med komponenter till Midas. Vi uppskattar alla bidrag - stora som smÄ!
Innan du börjar koda, lÀs gÀrna om vÄr designfilosofi och arkitektur för att förstÄ hur vi bygger komponenter.
đŠ Bygga komponenterâ
Styleguideâ
AnvÀnd befintliga komponenter som referens för struktur och namngivning. Se Àven React Aria för inspiration.
Skapa storiesâ
Alla states bör finnas representerade som stories i Storybook. Storybook Àr i första hand ett internt verktyg för UX och utvecklare i designsystemet men ocksÄ en publikt exponerad referens med API och visuell representation av komponenterna.
Skriv testerâ
De stories du skapat kan anvÀndas som utgÄngspunkt för komponenttester. LÀs mer om hur vi testar komponenter.
Dokumentationâ
Dokumentera komponentens API (props, events etc.) med TypeScript-typer sÄ genereras API-dokumentationen automatiskt. LÀgg Àven till relevanta exempel och anvÀndningsfall med kodexempel.
đż Versionshanteringâ
Vi anvÀnder en enkel branchstrategi med en main-branch som alltid ska vara i ett deploybart skick. Utveckling sker i feature- eller bugfix-brancher som sedan mergas in i main. Följ conventional commits - det avgör vilken versionsÀndring som sker.
Se arbetsflöde för detaljerad guide om commits och release-processen.
â Checklista för PRâ
Innan du skapar en pull request, kontrollera att:
- Komponenten följer befintliga patterns och styleguide
- Alla relevanta states finns som stories i Storybook
- Komponenttester Àr skrivna och passerar (
nx test components) - Dokumentation Àr uppdaterad
- Commits följer conventional commits-format
- Commit-historiken Àr stÀdad (anvÀnd
git rebase -ivid behov)
Release sker automatiskt via CI/CD nĂ€r din PR mergas till main. Du behöver inte köra nĂ„gra manuella release-kommandon! đ