Berkontribusi ke Core

Repositori inti Blockly berisi kode yang diperlukan untuk menjalankan aplikasi berbasis Blockly.

Perlu Diketahui

Berikut ini ringkasan fakta tentang blockly core yang perlu Anda ketahui untuk membuat PR.

  • Cabang yang berfungsi adalah develop dan semua PR harus dibuat terhadap develop.
  • Anda harus mengisi template permintaan pull dengan informasi yang diminta.
  • Kode harus sesuai dengan Panduan Gaya TypeScript Google.
  • Gunakan commit konvensional dalam pesan commit dan judul permintaan pull Anda.
  • String yang terlihat pengguna harus berada dalam file /msg/messages.js agar dapat diterjemahkan. Kurang dari 6% penduduk dunia menggunakan bahasa Inggris sebagai bahasa ibu.
  • Teks pada blok umumnya harus dalam huruf kecil (seperti kata kunci di sebagian besar bahasa pemrograman).
  • Mempertahankan kompatibilitas mundur. Ada banyak aplikasi Blockly di internet, jangan ganggu orang lain.

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

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

Membuat dan Memverifikasi Perubahan

  1. Jalankan npm install untuk menginstal dependensi.
  2. Jalankan npm run start untuk memulai server yang menjalankan playground. Anda dapat menggunakan halaman ini untuk menguji perilaku yang ada. Lihat halaman playground untuk mengetahui informasi selengkapnya.
  3. Buat perubahan yang diperlukan pada kode.
  4. Jika Anda membiarkan server berjalan, muat ulang untuk melihat perubahan. Jika tidak, mulai ulang server dan pastikan kode berperilaku seperti yang diharapkan dan tidak ada error atau peringatan di konsol.
  5. Jalankan npm run build dan pastikan tidak ada error build.
  6. Menulis pengujian otomatis. Biasanya, ini akan berupa pengujian mocha di direktori tests/mocha, tetapi kami mungkin meminta jenis pengujian lainnya.
  7. Jalankan npm run format untuk memformat kode dan otomatis memperbaiki beberapa masalah lint.
  8. Jalankan npm test untuk menjalankan pengujian otomatis. Tindakan ini juga menjalankan eslint.
  9. Jika ada error lint, jalankan npm run lint:fix untuk memperbaiki masalah yang dapat diperbaiki secara otomatis. Atasi peringatan atau error lint yang tersisa.
  10. Jika semua pengujian lulus, Anda siap untuk membuka PR terhadap pengembangan dengan perubahan Anda.