Menulis Permintaan Pull yang Baik

Permintaan pull mirip seperti darah dari repositori. Mereka menjaga semuanya tetap sehat dan bergerak. Halaman ini menjelaskan cara membuat PR yang lengkap dan mudah ditinjau, yang membuat PR Anda kemungkinan besar akan digabungkan.

Berikut adalah langkah-langkah yang dapat diambil untuk memastikan Anda membuat PR terbaik.

  1. Komunikasi
  2. Memulai Persiapan
  3. Jaga agar Tetap Kecil
  4. Jaga agar Tetap Bersih
  5. Menguji Perubahan
  6. Komunikasi (pt2)

Komunikasikan

Sebelum Anda terjun dan mulai menulis kode, sebaiknya komunikasikan dengan tim inti agar mereka tahu apa yang Anda minati.

Jika ada masalah yang Anda minati, beri komentar pada masalah tersebut dan sampaikan bahwa Anda akan mulai menanganinya. Ini memastikan bahwa kita tidak memiliki banyak orang yang mengerjakan hal yang sama. Seorang anggota tim akan menanggapi untuk mengonfirmasi bahwa itu milik Anda.

Jika Anda memiliki ide yang tidak tercakup dalam masalah, harap tuliskan ide tersebut sebelum Anda mulai bekerja. Hal ini memberi tim kesempatan untuk mendiskusikan cara terbaik untuk menerapkan perubahan sebelum Anda mulai melakukan perubahan, sehingga Anda tidak perlu bekerja dalam jangka panjang.

Memulai Persiapan

Jika ini pertama kalinya Anda berkontribusi pada contoh Blockly atau blockly, mulailah dari halaman penyiapan pengembangan.

Jaga agar Tetap Kecil

Selalu usahakan agar perubahan Anda kecil dan terfokus. Kami lebih baik meninjau beberapa PR yang lebih kecil daripada meninjau satu PR raksasa. Beberapa aturan praktis yang baik adalah:

  • Perbaiki satu masalah. Jangan mencoba untuk mengatasi beberapa masalah sekaligus.
  • Batasi cakupan. Biasanya PR memerlukan waktu < 8 jam (bergantung pada pemahaman Anda dengan codebase).
  • Gunakan commit. Jika PR Anda terasa agak besar, bagi perubahan menjadi grup logis menggunakan commit git.

Jaga agar Tetap Bersih

Mengapa perlu memperhatikan gaya kode? Kami akan menanganinya untuk jangka panjang, dan gaya yang konsisten membuat pemeliharaan lebih mudah. Gaya mengacu pada cara Anda menamai variabel, tetapi juga mencakup cara Anda menyusun kode, menulis komentar, dan banyak lagi. Jika memungkinkan, kami akan menggunakan alat seperti eslint untuk mengotomatiskan pemeriksaan gaya.

Selain eslint, ikuti panduan berikut:

Uji Perubahan Anda

Sebelum melakukan PR, Anda harus selalu menguji apakah perubahan telah berfungsi, sehingga Anda tidak perlu kembali dan memperbaiki masalahnya nanti. Berikut adalah beberapa ide untuk menguji berbagai kategori project:

  • Untuk plugin: tulis pengujian mocha otomatis yang mencakup perubahan Anda.
  • Untuk contoh: uji secara manual semua fungsi yang ditunjukkan.
  • Untuk codelab: jalankan seluruh tutorial di lingkungan yang bersih dan uji setiap contoh kode yang Anda berikan.

Komunikasikan

Ini adalah bagian terakhir dan bisa dibilang bagian terpenting dalam membuat PR: menulis ringkasan.

Menulis ringkasan PR yang baik dapat membantu developer lain meninjau perubahan Anda, sehingga kemungkinan besar akan lebih cepat diterima.

Ringkasan Anda harus mencakup hal-hal seperti:

  • Masalah yang terkait dengan PR Anda.
  • Perubahan yang ditambahkan Humas Anda.
  • Cara Anda menguji perubahan.
  • Apa pun yang Anda ingin agar ditinjau oleh peninjau.
  • Informasi lain yang menurut Anda dibutuhkan oleh peninjau.

Jika mengikuti template PR saat membuat permintaan, Anda harus siap. Ingatlah untuk menjelaskannya seringkas dan sepenuhnya.

Selamat Membuat Coding!