Berkontribusi pada Sample

Blockly Samples berisi konten tambahan terkait Blockly yang bukan bagian dari repositori inti, termasuk plugin, codelab, dan kode contoh. Untuk penjelasan selengkapnya tentang setiap fungsi, lihat halaman Struktur Repositori.

Perlu Diketahui

Berikut ringkasan fakta tentang contoh blok yang perlu Anda ketahui untuk membuat PR.

  • Cabang yang berfungsi adalah master dan semua PR harus dibuat terhadap master.
  • Jalankan npm install di level root contoh blockly, bukan di level plugin individual. Contoh blockly adalah monorepo, yang berarti berisi beberapa paket dalam repositori yang sama, dan menginstal pada tingkat root adalah bagian dari alur kerja untuk mengelola monorepo dengan Lerna.
  • Kode harus sesuai dengan Panduan Gaya JavaScript atau Panduan Gaya TypeScript Google, bergantung pada bahasa yang digunakan.
  • Gunakan commit konvensional dalam pesan commit dan judul permintaan pull.

  • Setiap file kode baru harus diawali dengan Lisensi Apache v2.0:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

Buat dan Verifikasi Perubahan

  1. Jalankan npm install pada tingkat root contoh blockly untuk menginstal dependensi.
  2. Jalankan npm run start di direktori plugin untuk membuat dan memulai server yang menjalankan halaman pengujian plugin. Anda dapat menggunakan halaman ini untuk melihat perilaku plugin yang ada, atau jika menambahkan plugin baru, Anda harus menjadikan ini halaman pengujian yang berguna agar orang lain dapat melihat fungsi plugin Anda. Lihat halaman playground untuk informasi selengkapnya.
  3. Buat perubahan yang diperlukan pada kode plugin.
  4. Jika Anda membiarkan server tetap berjalan, perubahan akan dimuat secara otomatis. Jika tidak, mulai ulang server dan pastikan plugin berperilaku seperti yang diharapkan dan tidak ada error atau peringatan di konsol.
  5. Jalankan npm run build dan pastikan tidak ada error build.
  6. Tulis pengujian mocha otomatis di direktori test/.
  7. Jalankan npm run test untuk menjalankan pengujian otomatis.
  8. Jalankan npm run lint:fix untuk memperbaiki error lint. Atasi peringatan atau error yang tersisa.
  9. Jalankan npm run format untuk menjalankan pemformat otomatis.
  10. Jika semua pengujian lulus, Anda siap membuka PR terhadap master dengan perubahan Anda.