Kitvue NPM | npm.io

kitvue - Pegadaian Design System

Getting started

npm install git+https://repo.pegadaian.co.id/client/pegadaian-ui-kit-vue.git

Configuration

Add sass plugin

vue add style-resource-loader

On your vue config add

const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
  transpileDependencies: ['bootstrap-vue'],

  pluginOptions: {
    'style-resources-loader': {
      preProcessor: 'scss',
      patterns: []
    }
  }
})

Spesific on line

transpileDependencies: ['bootstrap-vue'],

pluginOptions: {
    'style-resources-loader': {
        preProcessor: 'scss',
        patterns: []
    }
}

kitvue - Pegadaian Design System - Kontribusi

kitvue adalah library komponen UI yang dikembangkan untuk mendukung proyek-proyek internal di Pegadaian. Library ini menggunakan Vue versi 3.4.7 dan Bootstrap CSS versi 5.3.2 sebagai teknologi utama.

Branches

Kami menggunakan dua branch utama dalam pengembangan proyek ini:

master: Branch ini berisi versi stabil dari library yang akan di-publish sebagai package di artifactory pegadaian.
dev-update-component: Branch ini digunakan sebagai branch pengembangan utama. Semua fitur baru dan perbaikan akan di-review di sini sebelum di-merge ke master.

Kontribusi

Kami sangat menyambut kontribusi dari developer lain untuk menambahkan komponen baru, memperbaiki styling, atau melakukan bug fixing pada komponen yang ada.

Langkah-Langkah Kontribusi

Fork dan Clone Repository

Fork repository kitvue ke akun GitHub kamu.

Clone repository fork kamu:

git clone https://repo.pegadaian.co.id/client/pegadaian-ui-kit-vue.git

cd pegadaian-ui-kit-vue

Checkout Branch dev-update-component
- Pastikan kamu selalu bekerja dari branch pengembangan, dev-update-component:
```
git checkout dev-update-component
```
Buat Branch Baru dari dev-update-component
- Untuk Penambahan Komponen Baru:
  - Buat branch baru dengan penamaan dev-add-(nama-komponen):
  - Contoh jika kamu melakukan penambahan komponen button :
```
git checkout -b dev-add-button
```
- Untuk Update atau Bug Fixing Komponen yang Ada:
  - Buat branch baru dengan penamaan dev-update-(nama-komponen):
  - Contoh jika kamu melakukan penambahan komponen button :
```
git checkout -b dev-update-button
```
Mulai Pengembangan
- Penambahan Komponen Baru:
  - Tambahkan komponen baru sesuai dengan standar kode yang telah disepakati.
  - Pastikan untuk menulis komentar dan menambahkan dokumentasi yang relevan.
- Update atau Bug Fixing:
  - Perbaiki bug atau update styling komponen yang ada.
  - Tambahkan komentar untuk memastikan perubahan tersebut.

Commit dan Push

Buat commit yang jelas dan deskriptif:

git commit -m "Add Button component with primary and secondary variants"
git push origin dev-add-button

Buka Merge Request (PR)
- Setelah selesai, buka Merge Request ke branch dev-update-component.
- Tambahkan deskripsi mengenai perubahan yang kamu lakukan.
Code Review
- Merge Request kamu akan di-review oleh maintainer proyek.
- Lakukan perbaikan berdasarkan umpan balik yang diberikan.
Merge ke dev-update-component
- Setelah review selesai, request akan di-merge ke dev-update-component.

Penting Diperhatikan

Penamaan Branch

Penambahan Komponen Baru:
- Branch name: dev-add-(nama-komponen)
- Contoh: dev-add-button, dev-add-modal
Perbaikan atau Update Komponen yang Ada:
- Branch name: dev-update-(nama-komponen)
- Contoh: dev-update-button, dev-update-card

Praktik Terbaik

Coding Style: Ikuti pedoman coding style yang ada dalam proyek ini.
Test: Selalu tambahkan atau perbarui unit tests untuk memastikan kode yang kamu tambahkan atau ubah berfungsi dengan baik.
Dokumentasi: Jangan lupa untuk menambahkan atau memperbarui dokumentasi jika kamu menambahkan fitur baru atau mengubah yang sudah ada.
Jaga Kualitas: Semua kode harus melalui proses review dan testing sebelum di-merge ke branch dev-update-component.

Terima kasih telah berkontribusi ke kitvue! Kami sangat menghargai usaha dan waktu yang kamu luangkan untuk membuat proyek ini menjadi lebih baik.