Cara sukses dengan Tinjauan Kode

Tinjauan Kode adalah topik yang sangat relevan saat ini, banyak orang menganggapnya hanya sebagai hambatan dan orang lain menganggapnya sangat serius. Mari kita bahas tentang cara meraih kesuksesan (untuk seluruh tim, bukan hanya Anda) dalam bagian yang sangat penting dalam proses pembuatan perangkat lunak ini.

Masalah dan cara memperbaikinya (atau menghindarinya)

Biasanya, ketika Anda selesai mengembangkan beberapa fitur baru dan Permintaan Tarik Anda sudah siap untuk ditinjau, beberapa masalah muncul:

Tidak ada yang melakukan peninjauan

Ya, ini adalah hal yang sangat umum. Anda mengerahkan seluruh upaya Anda untuk melakukan yang terbaik yang Anda bisa dan tidak ada yang meninjaunya.

Ada beberapa hal yang dapat Anda tingkatkan:

  • Anda memberi tahu orang dengan cara yang salah: Mungkin menugaskan seseorang di PR Github saja tidak cukup? Kirimkan tautan dengan cara yang menyenangkan di beberapa saluran Slack untuk menarik perhatian atau sekadar bertanya langsung kepada seseorang.
  • Rekan Peninjau Kode: Ya, buat saja beberapa teman peninjau kode (satu atau lebih), Anda selalu dapat memeriksa PR satu sama lain dan bergerak sangat cepat dengan pekerjaan Anda. Ini semacam kompromi untuk saling meninjau.
  • Lakukan bagian Anda: Ingatlah bahwa bagian dari permainan ini adalah Anda harus meninggalkan beberapa komentar, meminta perubahan, dan menyetujui PR orang lain. Jika Anda membantu orang lain untuk meningkatkan kode mereka, mereka akan membantu Anda dengan cara yang sama. (Atau kemungkinan besar mereka akan mengomentari sesuatu dan akhirnya menyetujuinya).
  • Terlalu banyak perubahan: Salah satu penyebab yang paling mungkin adalah PR Anda terlalu besar! Jadi, cobalah untuk membuat perubahan Anda singkat dan ringkas, jangan melakukan refactoring secara gila-gilaan (pramuka) dan cobalah membagi pekerjaan Anda menjadi lebih banyak permintaan tarik. Mungkin bagian dari pembagian pekerjaan Anda ini bisa dimulai dari pertemuan perencanaan atau penyempurnaan tim Anda :).

Terlalu banyak orang yang mengulasnya

Dan juga, kita mempunyai masalah sebaliknya. Anda meletakkan pesan tinjauan kode di saluran "Umum" di Slack, dan tiba-tiba, banyak orang punya waktu untuk meninjau kode PR Anda. Sekarang Anda memiliki terlalu banyak perubahan dan permintaan perubahan yang harus Anda selesaikan agar Anda dapat menggabungkan perubahan Anda.

  • Mulailah meminta hanya satu orang untuk mengulas. Anda dapat mencobanya dengan salah satu rekan kerja yang Anda kenal akan memeriksa semuanya dengan sangat baik dan Anda percaya. Perbaiki komentarnya terlebih dahulu, dan PR Anda akan lebih halus dan dengan satu persetujuan awal. Kemudian, komunikasikan secara lebih luas kepada orang lain untuk memeriksanya. Pada titik ini, masyarakat hanya boleh meninggalkan komentar dan persetujuan kecil.
  • Teman peninjau kode (ya, ini juga berfungsi dengan sangat baik untuk mencegah masalah ini).
  • Perbaiki semua komentar dan minta putaran kedua pada saat yang sama: Jangan hanya memperbaiki komentar oleh pengembang, perbaiki semuanya terlebih dahulu.

Perdebatan teknis tentang komentar

Biasanya, Pengembang Perangkat Lunak suka membuat perdebatan teknis dari waktu ke waktu. Secara umum, ini adalah hal yang baik dan membuat Anda belajar lebih banyak dan mengidentifikasi beberapa teknologi atau konsep teknis baru yang tidak Anda ketahui sebelumnya. Tapi, masalahnya adalah beberapa orang cenderung melakukan ini di Code Review.

Ketika mengalami masalah ini, dan diskusi tentang suatu perubahan terlalu panas atau terlalu lama, Anda dapat melakukan hal berikut:

  • Hentikan segera: Dekati pengembang lain secara pribadi untuk mendiskusikan komentar. Terkadang, Anda berdua memerlukan penjelasan tatap muka untuk memahami sepenuhnya argumen dan saran.
  • Jangan menganggapnya pribadi: jaga agar tetap profesional.
  • Jelaskan diri Anda menggunakan argumen yang nyata dan konsisten: seperti pola desain, arsitektur, pedoman gaya, atau bahkan pengalaman sebelumnya. Cobalah untuk tidak hanya bertahan pada pendapat saja.
  • Pertahankan fokus dalam memberikan fitur kepada pelanggan: Terkadang, seseorang menyarankan pendekatan berbeda untuk melakukan hal yang sama, membandingkan keuntungan dari kedua penerapan. Mungkin peningkatan waktu eksekusi sebesar 0,0001ms tidak diperlukan, atau mungkin sarannya akan banyak meningkatkan kemampuan pemeliharaan kode Anda. Jika waktu yang dihabiskan untuk melakukan perbaikan tidak terlalu banyak dan ini menambah nilai nyata, perbaikilah!
  • Ketika Anda berdua mencapai kesepakatan, tuliskan kesimpulannya di PR.

Hal-hal yang baik

Ketika Anda memiliki ritme kerja yang baik, dan rekan kerja Anda memberikan komentar yang bermanfaat, Anda akan melihat banyak manfaat darinya:

  • Ini menurunkan risiko mengalami masalah pada QA
  • Menghadirkan fitur berkualitas
  • Anda belajar banyak dari pengembang lain dan orang lain belajar dari Anda (Transfer pengetahuan)
  • Ikatan kerja tim yang lebih baik. Fitur ini tidak hanya dikembangkan oleh Anda, tetapi juga mencakup keterampilan rekan kerja Anda dan keberhasilan fitur tersebut dibagikan kepada seluruh tim.

Kesimpulan

Ingatlah bahwa kerja tim sangat penting di sini. Tinjauan Kode tidak boleh menghalangi Anda atau tim Anda, ini adalah kesempatan bagus untuk membuat hal-hal hebat bersama dan belajar dari satu sama lain.

Jika menurut Anda saya perlu menambahkan sesuatu, beri tahu saya di komentar, dan bagikan pengalaman Anda juga!

Semoga kalian menyukai artikel ini, semoga harimu menyenangkan!

Gonzalo P.