Berkontribusi ke Core

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

Perlu Diketahui

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

  • Cabang yang berfungsi adalah mengembangkan dan semua PR harus dibuat terhadap pengembangan.
  • 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.
  • String yang terlihat oleh pengguna harus ada dalam file /msg/messages.js agar dapat diterjemahkan. Kurang dari 6% penduduk dunia berbicara bahasa Inggris secara native.
  • Teks pada blok umumnya harus berupa huruf kecil semua (seperti kata kunci dalam sebagian besar bahasa pemrograman).
  • Mempertahankan kompatibilitas mundur. Ada banyak aplikasi Blockly di luar sana, jangan ganggu aplikasi lain.

  • 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 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 informasi selengkapnya.
  3. Buat perubahan yang diperlukan pada kode.
  4. Jika Anda membiarkan server tetap berjalan, muat ulang untuk melihat perubahan Anda. 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, pengujian ini adalah pengujian moka di direktori tests/mocha, tetapi kami mungkin meminta jenis pengujian lainnya.
  7. Jalankan npm run format untuk memformat kode dan memperbaiki beberapa masalah lint secara otomatis.
  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 error atau peringatan lint yang tersisa.
  10. Jika semua pengujian lulus, Anda siap membuka PR untuk mengembangkan dengan perubahan Anda.