Permintaan pull seperti darah kehidupan repositori. Mereka menjaga semuanya tetap sehat dan bergerak. Halaman ini menjelaskan cara membuat PR yang lengkap dan mudah ditinjau, sehingga PR Anda lebih mungkin digabungkan.
Berikut adalah langkah-langkah yang dapat Anda lakukan untuk memastikan Anda membuat PR terbaik.
Berkomunikasi
Sebelum Anda langsung mulai menulis kode, sebaiknya komunikasikan dengan tim inti agar mereka tahu apa yang Anda minati.
Jika ada masalah yang Anda minati, berikan komentar pada masalah tersebut yang menyatakan bahwa Anda akan mulai mengerjakannya. Hal ini memastikan bahwa kita tidak memiliki beberapa orang yang mengerjakan hal yang sama. Anggota tim akan merespons untuk mengonfirmasi bahwa akun tersebut adalah milik Anda.
Jika Anda memiliki ide yang tidak tercakup dalam masalah, harap tulis masalah tersebut sebelum Anda mulai bekerja. Hal ini memberi tim kesempatan untuk mendiskusikan cara terbaik untuk membuat perubahan sebelum Anda mulai mem-build, sehingga menghemat pekerjaan Anda dalam jangka panjang.
Memulai Persiapan
Jika ini pertama kalinya Anda berkontribusi pada Blockly atau blockly-samples, mulailah dari halaman penyiapan pengembangan.
Buat Tetap Kecil
Selalu usahakan agar perubahan Anda tetap kecil dan terfokus. Kami lebih suka meninjau beberapa PR yang lebih kecil daripada meninjau satu PR besar. Beberapa aturan praktis yang baik adalah:
- Perbaiki satu masalah. Jangan mencoba mengatasi beberapa masalah sekaligus.
- Batasi cakupan. Biasanya PR memerlukan waktu < 8 jam (bergantung pada pengetahuan Anda tentang codebase).
- Gunakan commit. Jika PR Anda terasa sedikit besar, bagi perubahan menjadi grup logis menggunakan commit git.
Jaga Kebersihan
Mengapa gaya kode itu penting? Kami ingin melakukannya dalam jangka panjang, dan gaya yang konsisten akan mempermudah pemeliharaan. Gaya mengacu pada cara Anda memberi nama variabel, tetapi juga mencakup cara Anda menyusun kode, menulis komentar, dan lainnya. Jika memungkinkan, kami akan menggunakan alat seperti eslint untuk mengotomatiskan pemeriksaan gaya.
Selain eslint, ikuti panduan berikut:
Menguji Perubahan
Sebelum membuat PR, Anda harus selalu menguji apakah perubahan Anda berfungsi, sehingga Anda tidak perlu kembali dan memperbaikinya nanti. Berikut beberapa ide untuk menguji berbagai kategori project:
- Untuk plugin: tulis pengujian mocha otomatis yang mencakup perubahan Anda.
- Untuk contoh: uji semua fungsi yang Anda tunjukkan secara manual.
- Untuk codelabs: jalankan seluruh tutorial di lingkungan yang bersih dan uji kode contoh yang Anda berikan.
Berkomunikasi
Ini adalah bagian terakhir dan mungkin yang paling penting dalam membuat PR: menulis ringkasan.
Menulis ringkasan PR yang bagus akan membantu developer lain meninjau perubahan Anda, sehingga kemungkinan perubahan tersebut akan diterima lebih cepat.
Ringkasan Anda harus mencakup hal-hal seperti:
- Masalah yang terkait dengan PR Anda.
- Perubahan yang ditambahkan PR Anda.
- Cara Anda menguji perubahan.
- Apa pun yang ingin Anda minta peninjau untuk periksa.
- Informasi lain yang menurut Anda diperlukan peninjau.
Jika Anda mengikuti template PR saat membuat permintaan, Anda akan baik-baik saja. Ingatlah untuk membuatnya seringkas dan lengkap.
Selamat Coding!