Berkontribusi pada inti

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

Perlu Diketahui

Berikut ringkasan singkat tentang fakta-fakta inti Blockly yang perlu Anda ketahui untuk membuat PR.

  • Cabang kerja adalah main dan semua PR harus dibuat terhadap main.
  • Anda harus mengisi template pull request dengan informasi yang diminta.
  • Kode harus sesuai dengan Panduan Gaya TypeScript Google.
  • Gunakan conventional commits dalam pesan commit dan judul pull request Anda.
  • String yang terlihat oleh pengguna harus ada dalam file /msg/messages.js agar dapat diterjemahkan. Kurang dari 6% penduduk dunia yang berbahasa Inggris sebagai bahasa ibu.
  • Teks pada blok umumnya harus berupa huruf kecil semua (sama seperti kata kunci di sebagian besar bahasa pemrograman).
  • Mempertahankan kompatibilitas mundur. Ada banyak aplikasi Blockly di luar sana, jadi jangan merusak pengalaman pengguna lain.

  • Setiap file kode baru harus memiliki awalan 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 tetap berjalan, refresh untuk melihat perubahan Anda. Jika tidak, mulai ulang server dan verifikasi bahwa 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 adalah pengujian mocha di direktori tests/mocha, tetapi kami dapat meminta Anda untuk melakukan 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 semua peringatan atau error lint yang tersisa.
  10. Jika semua pengujian lulus, Anda siap membuka PR terhadap main dengan perubahan Anda.