Kontribusi di Alurkerja-UI

Menjalankan Project

1. Pastikan memiliki akses di repo ini Repo Alurkerja-UI. jika belum minta ke maintener nya
2. Clone repository nya dengan perintah git clone https://gitlab.javan.co.id/alurkerja/alurkerja-ui.git
3. Install depedencies nya dengan perintah yarn
4. Untuk development jalankan perintah yarn storybook

File Structure

Folder Name	Description
__test__	Folder yang menyimpan file unit testing. didalamnya dibagi lagi menjadi 2 folder yaitu components dan utils
api	Folder yang menyimpan file untuk fetching API
assets	Folder yang menyimpan file styling (scss) dan file gambar/icon
components	Folder untuk menyimpan component2
configs	Folder untuk menyimpan file-file config
features	Folder untuk menyimpan komponen yang memilik build-in feature seperti TableLowcode, AlurkerjaForm yang memiliki fitur CRUD
hooks	Folder untuk menyimpan custom hooks dengan prefix use
stories	Folder untuk menyimpan stories atau dokumentasi komponen yang dibuat menggunakan storybook
utils	Folder function atau konstanta yang reusable. 1 function 1 file

How to Create New component

1. Di folder components buat folder baru dengan nama component yang ingin dibuat. didalamnya buatlah 2 file [namaComponent].tsx dan index.ts untuk mengexport komponen
2. Setelah component jadi untuk testing nya buatlah folder baru dengan nama komponen terkait didalam folder stories > components didalamnya buatlah file [namaComponent].stories.{tsx, ts}. gunakan .ts apabila tidak terdapat JSX.Element, dan gunakan .tsx jika terdapat JSX.Elemen
3. Buat stories nya
4. Jalankan perintah yarn storybook maka halaman dokumentasi untuk komponent tersebut akan di generate sesuai configurasi stories nya
5. Jika components sudah oke, untuk versioning bisa lakukan MR ke branch develop dan mention maintener alurkerja-ui
6. Maintener akan segera mengupdate version nya

Modify an Existing file

1. Untuk saat ini unit test belum diterapkan untuk semua components dan function
2. namun apabila function yang di edit sudah memiliki unit test nya seperti objToQueryParam() maka ketika mengedit file tersebut pastikan unit test nya lolos dengan menjalankan perintah yarn test

How to Contribute by Solving an Issue on Gitlab

1. Pada halaman issue nya click icon v pada button Create merge request untuk membuat branch dan MR baru
2. kerjakan di branch tersebut dan apabila sudah selesai maka push ke branch tersebut
3. lalu mention maintener alurkerja-ui untuk merge MR tersebut dan melakukan versioning

Note

1. Pada TableLowcode sudah menggunakan React.Context untuk state management nya, jadi hindari Props Drilling
2. hindari penggunaan type any