Proses Peninjauan Kode

Gol

Proses peninjauan kami memiliki beberapa tujuan:

  • Pastikan kode berkualitas tinggi, baik dalam fungsi maupun keterbacaan.
  • Menangkap bug, karena bug terjadi.
  • Pertahankan gaya yang konsisten agar mudah untuk mulai bekerja di bagian codebase mana pun.

Semua kode yang masuk ke blockly-samples dan core Blockly akan ditinjau, baik kode tersebut ditulis oleh kontributor komunitas maupun anggota tim Blockly.

Sebagai peninjau, kami ingin bekerja sama dengan Anda untuk membuat perubahan Anda sebaik mungkin. Kami meminta Anda, sebagai kontributor, terlibat dalam percakapan dengan kami untuk meminta permintaan pull Anda melalui peninjauan dan penggabungan.

Proses

Proses peninjauan PR melalui beberapa tahap:

  1. Tugas
  2. Masukan
  3. Diskusi
  4. Revisi
  5. Pengulangan
  6. Gabungkan!

Assignment

Saat permintaan pull Anda masuk, anggota panggilan dari tim Blockly akan menetapkan peninjau.

Peninjau dipilih berdasarkan keahlian dan mendistribusikan beban kerja secara merata.

Mungkin perlu waktu beberapa hari untuk mendapatkan peninjau yang ditetapkan, dan beberapa hari lagi untuk mendapatkan peninjauan. Jangan khawatir, ini normal.

Masukan

Selama tahap pemberian masukan, peninjau memberikan saran untuk perubahan pada siaran pers Anda. Langkah-langkah berikut dapat berupa hal-hal sederhana untuk membuat kode Anda sesuai dengan panduan gaya JavaScript Google. Atau bisa juga hal yang lebih besar seperti meminta Anda untuk mengatur ulang definisi fungsi.

Peninjau dianjurkan untuk menggunakan peninjauan kode GitHub (bukan membuat komentar satu per satu) sehingga Anda menerima satu notifikasi, bukan beberapa notifikasi.

Diskusi

Fase diskusi adalah kesempatan Anda untuk menanggapi umpan balik. Mungkin salah satu komentar ulasan tidak jelas: sekarang adalah kesempatan Anda untuk meminta klarifikasi. Atau mungkin peninjau meminta perubahan, tetapi menurut Anda perubahan tersebut akan memiliki akibat: sekarang adalah kesempatan Anda untuk menemukan kompromi.

Revisi

Fase revisi adalah di mana Anda bisa membuat perubahan pada PR Anda. Biasanya, perubahan ini adalah hasil dari sesuatu yang dikatakan peninjau Anda pada fase masukan.

Setelah menyelesaikan revisi, sebaiknya beri tag pada peninjau yang meminta mereka untuk meninjaunya kembali.

Pengulangan

Setelah fase revisi, peninjau Anda memiliki kesempatan lain untuk memberikan masukan, dan prosesnya dimulai dari awal.

Sering kali peninjauan kedua sederhana dan berfokus pada nit seperti tanda baca dan gaya kode. Tetapi terkadang ulasan kedua bisa sangat besar. Peninjau pertama Anda bahkan mungkin meminta orang lain untuk melihat, untuk mendapatkan perspektif baru.

Gabungkan!

Fase penggabungan adalah kesempatan Anda untuk merayakan. Anda telah membuat perubahan, mendiskusikan dan merevisinya, dan akhirnya digabungkan. Ini adalah pencapaian besar yang tidak pernah dimulai oleh banyak orang, apalagi diselesaikan!

Terima kasih atas kerja keras Anda untuk menjadikan Blockly lebih baik. Dan selamat!