Tinjauan Kode yang Efektif
Tinjauan kode adalah bagian penting dari tim pengembangan perangkat lunak apa pun, ini membantu Anda mengurangi kemungkinan memiliki kode buggy.
Saya sendiri telah melakukan tinjauan kode selama lebih dari 6 tahun sekarang dan saat itu saya telah meninjau lebih dari 600 permintaan Tarik. Saya sekarang menulis posting ini untuk membagikan pembelajaran saya, dengan harapan ini akan membantu Reviewer dan Reviewee.
Sebelum kita masuk ke lubang kelinci tentang apa dan apa yang tidak boleh dilakukan selama tinjauan kode, saya ingin menyoroti pentingnya tinjauan kode.
Orang biasanya menganggap review kode sebagai tugas kasar yang hanya menambah waktu antara "Dev Done" dan "Ready for QA". Pernyataan tersebut di atas adalah "benar" ketika tinjauan Kode dilakukan " Tidak dengan niat yang benar ".
Berikut adalah beberapa skenario yang menggabungkan peninjauan kode yang dilakukan tetapi tidak membantu siapa pun —
- Peninjau melakukan tinjauan kode hanya untuk melakukannya. Dia menyetujui permintaan tanpa melihat atau hanya menggulirnya sekali.
Peninjau jenis ini segera diberi label sebagai peninjau yang mudah dan kemudian ditargetkan untuk mendapatkan kode lebih cepat. - Peninjau melakukan tinjauan kode tanpa memahami persyaratan tugas
- Peninjau menambahkan komentar tanpa alasan sebenarnya di balik mengapa perubahan itu diperlukan
- Peninjau hanya memeriksa sintaks dan bukan logika yang sebenarnya.
Jika seorang reviewer berpikir bahwa reviewee tahu lebih banyak darinya, hal ini pasti akan terjadi. - Reviewee tidak mencoba memahami alasan di balik komentar. Jadi entah dia hanya mengikuti komentar secara membabi buta atau mengabaikannya
Mengapa saya harus meninjau kode orang lain?
Orang mungkin berpikir tidak ada untungnya meninjau kode orang lain karena mereka mungkin percaya bahwa mereka tidak mempelajari sesuatu yang baru. Di sisi lain-
- Peninjau mendapatkan pemahaman tentang tugas-tugas yang terjadi dalam tim.
- Mereka mengenal layanan yang ada di dalam sistem. Yang meningkatkan kegunaan kembali
- Mereka belajar sintaks baru atau cara coding dan melakukan sesuatu
Namun, saya masih akan mencantumkan beberapa hal yang biasanya dilewatkan orang saat melakukan tinjauan kode.
Petunjuk umum
- Perhatian khusus harus diberikan pada "Keterbacaan kode" dan "penggunaan kembali kode".
Nama variabel dan fungsi bersifat deskriptif dan bermakna. Nama sepertii,atidak boleh digunakan. - Kode tidak boleh berlebihan (alat kualitas kode seperti "sonarlint" sangat membantu dalam kasus ini)
- Kasus uji unit adalah suatu keharusan untuk fungsi utilitas
- Setiap fungsi pekerjaan harus didefinisikan dengan jelas dan harus mengikuti prinsip tanggung jawab tunggal
- Periksa level log. Konten log harus memiliki informasi yang dapat ditindaklanjuti
Sesuatu seperti — “mendapat kesalahan dari cache” tidak memiliki informasi yang dapat ditindaklanjuti - Kita harus memiliki metrik di mana pun diperlukan
- Periksa apakah proses (pencatatan, panggilan eksternal, basis data, cache) perlu disinkronkan atau tidak disinkronkan
- Orang biasanya tidak terlalu memperhatikan Unit Test Case. Beberapa pemikiran harus diberikan apakah semua skenario tercakup atau tidak
- Untuk fitur penting yang mungkin memengaruhi perjalanan pengguna, seseorang harus selalu memiliki fallback untuk kembali ke alur sebelumnya
- Orang yang ditinjau harus mencoba memecah perubahan menjadi beberapa komponen yang lebih kecil dan membuat permintaan tarik untuk perubahan tersebut secara mandiri dan sedini mungkin. Hal ini tidak hanya memberikan lebih banyak waktu kepada peninjau, tetapi juga memastikan bahwa masalah (jika ada) atau skenario tepi dapat diketahui lebih awal
- Tidak percaya siapapun. Pertanyakan Semuanya. Terkadang, jika kita mempercayai pembuatnya, kita tidak menggali lebih dalam kode mereka.
- Orang yang diulas harus mengoreksi permintaan penarikannya setidaknya satu kali sebelum membagikannya untuk ditinjau. Ini memastikan bahwa hal-hal dasar seperti — kode yang dikomentari, TODO yang tertunda, perubahan spasi, dll diperbaiki bahkan sebelum membagikan PR
- Periksa cabang sumber dan tujuan, apakah sudah benar atau tidak.
- Apakah panggilan eksternal sangat digabungkan atau tidak (artinya sangat digabungkan — kesalahan dalam panggilan eksternal akan menyebabkan kesalahan dalam aliran ini)
- Timeout dan mekanisme coba lagi
- Pengambilan sampel dan persyaratan pembatasan laju
- Metrik untuk panggilan eksternal (latensi, tingkat keberhasilan)
- Periksa TTL default dan logika penyegaran cache
- Kami juga harus memperkirakan jumlah entri baru dan rasio hit cache saat menambahkan cache
- Apa yang terjadi jika terjadi kesalahan dari cache
- Dalam kasus cluster cache baru — apakah ada konektivitas dari server ke instance cache
- Metrik untuk rasio hit cache
- Perkiraan jumlah kunci cache, ukuran rata-rata nilai, dan memastikan bahwa Infra memiliki kapasitas yang cukup.
- Periksa apakah ada indeks yang benar di DB untuk kueri baru
- Dalam hal database baru — apakah ada konektivitas atau tidak
- Kebijakan pembersihan tabel, untuk menghindari tabel besar dari waktu ke waktu, jika terjadi penyisipan data
- Metrik untuk kueri baru
- Hapus perubahan spasi putih dari permintaan Tarik
Bagaimana? Anda bisa merujuk ke ini - Jika saya tidak mengetahui persyaratan tersebut, saya biasanya memeriksa tugas atau menyinkronkan dengan pengembang sekali untuk memahami persyaratan tersebut
- Buka Permintaan Tarik di GitHub/BitBucket dan Editor Kode Lokal secara bersamaan.
Memiliki kode secara lokal memiliki banyak keuntungan —
- Anda dapat menggunakan alat pemindaian kode statis untuk menemukan beberapa masalah umum
- Navigasi kode jauh lebih mudah
- Jika diperlukan, Anda dapat menjalankan kode untuk melihat bagaimana perilakunya - Mulai dari titik di mana alur bisnis terpengaruh dan kemudian telusuri kode dari sana. Setiap kali saya pindah ke file lain, periksa apakah file itu telah berubah atau tidak dalam permintaan Tarik di Github.
- Jika ada masalah, tambahkan komentar itu di GitHub sambil menyebutkan apa yang perlu diubah dan mengapa? Seiring dengan beberapa bahan referensi
- Jika Anda selesai meninjau file — tandai sebagai dilihat, sehingga Anda juga mendapatkan kejelasan tentang kemajuan peninjauan dan juga, dapat menghindari file tersebut selama peninjauan kode kedua (jika tidak ada perubahan)
- Jika perubahan di diff kecil, saya meninjaunya sekaligus. Kalau tidak, saya membagi ulasan menjadi fase-fase kecil. Ini memastikan bahwa kualitas ulasan tidak terpengaruh. Secara umum yang terjadi adalah, jika perbedaannya besar, setelah beberapa saat, kami mulai menerima perubahan tanpa terlalu memikirkannya
Saya harap setidaknya ada satu hal yang Anda pelajari dari ini. Jika ya, lakukan upvote dan sebutkan juga poin yang mungkin saya lewatkan. Saya akan menambahkan mereka ke pos juga.
Cheers and Happy Review!

![Apa itu Linked List? [Bagian 1]](https://post.nghiatu.com/assets/images/m/max/724/1*Xokk6XOjWyIGCBujkJsCzQ.jpeg)



































