Alur Pengembangan
Menjalankan Proyek
Memahami Kebutuhan dan Menulis Kode
Ini adalah proses yang kompleks, tetapi umumnya mencakup tiga hal:
- Menentukan input:
vseed - Menentukan output:
vseedmenjadiadvancedVSeed, atauadvancedVSeedmenjadispec - Menulis kode dan memastikan input baru menghasilkan output sesuai harapan
playground (apps/website/docs/id-ID/playground/index.mdx) dapat digunakan untuk debugging dan pengembangan.
Membuat Test Case Baru
Jika diperlukan, pertimbangkan untuk membuat test case baru.
Ketika coverage turun, test case baru perlu dibuat.
Di direktori packages/vseed/tests/*, buat file testName.json baru dan tulis VSeed DSL di dalamnya.
Jalankan:
Menjalankan Unit Test dan Memperbarui Coverage
Pastikan tiga hal:
- Semua test lulus
- Perubahan snapshot sesuai harapan
- Coverage tidak turun
Perubahan coverage akan otomatis diperbarui ke README.md
Memperbarui Dokumentasi Opsi Konfigurasi
Jika mengubah definisi TypeScript untuk jenis chart, harap perbarui dokumentasi opsi konfigurasi.
Semua definisi tipe di bawah packages/vseed/src/types/chartType sesuai dengan dokumentasi opsi konfigurasi setiap chart. Jika ada perubahan, pastikan untuk memperbaruinya.
Rilis dan Submit
Setelah menjalankan perintah pnpm changeset, ikuti prompt untuk melakukan langkah berikut:
- Pilih package yang berubah; umumnya hanya
vseed - Ikuti semantic versioning dan pilih tipe perubahan. Dalam sebagian besar kasus, tekan Enter dua kali untuk melewati
majordanminor, lalu pilihpatch - Masukkan deskripsi perubahan, misalnya:
fix: chart render error caused by only one measure
Satu fitur atau Bugfix sesuai dengan satu changeset dan satu commit
Satu Pull Request sesuai dengan satu issue
Pull Request dengan beberapa fitur atau beberapa Bugfix sesuai dengan beberapa changeset dan beberapa commit