Cara mempercepat tinjauan kode

Ulasan kode buta huruf secara serius memperlambat alur kerja. Ketika sejumlah besar perubahan macet selama beberapa hari (atau minggu!), Maka rilis produk di pasar harus ditunda. Berikut adalah beberapa alasan mengapa ini terjadi:

  • Tidak ada desain kode standar
  • Tidak ada pemeriksaan otomatis yang digunakan
  • Pemrogram tidak menganalisis kode mereka secara independen.
  • Permintaan Kolam Besar
  • Permintaan Kolam Renang Yang Tidak Jelas
  • Tenggat waktu tidak ada untuk tinjauan kode

Tidak ada desain kode standar


Setiap tim harus mengadopsi standar format kode (standar pemrograman, panduan gaya), yang disetujui semua orang. Ini termasuk konvensi penamaan, struktur folder, pemformatan kode, dan daftar praktik terbaik, seperti pengujian unit, validasi, dll

. Kurangnya standar yang jelas dan konvensi memaksa setiap pengembang untuk menulis kode sesuka mereka, yang menyebabkan perselisihan kode. -ulasan. Jika Anda melihat banyak komentar tentang pemformatan, konvensi penamaan, dan banyak lagi, saatnya untuk berbicara tentang standar umum.

Tim Anda dapat mengembangkan set rekomendasi mereka sendiri, atau mulai dengan rekomendasi terkenal dari perusahaan lain. Ini adalah contoh dari Google .

Tidak ada pemeriksaan otomatis yang digunakan


Setelah mengadopsi standar kode, pelajari alat untuk memverifikasi kepatuhan dengan standar ini. Untuk hampir semua bahasa, ada alat untuk memformat kode, linter dan utilitas lain yang dapat Anda masukkan sebelum melakukan dan mendaftar dalam sistem CI / CD.

Alat-alat ini memeriksa kode untuk kepatuhan dengan standar desain dan memberi tahu penulis pelanggaran. Penulis mendapat kesempatan untuk memperbaiki masalah sebelum mengirim permintaan kumpulan, yang secara signifikan mengurangi kebisingan. Semakin banyak pemeriksaan yang lolos secara otomatis, semakin banyak waktu yang harus difokuskan oleh pengulas untuk masalah yang lebih serius, seperti kekurangan dalam arsitektur, kesenjangan implementasi, dll.

Pemrogram tidak menganalisis kode mereka secara independen.


Sebelum menghubungi kolega untuk peninjauan kode, penulis harus meninjau perubahannya sendiri. Ini seperti memeriksa teks surat untuk kesalahan ketik dan kesalahan sebelum mengirimnya ke penerima.

Dalam praktiknya, memvalidasi kode Anda sendiri sangat menantang karena Anda cenderung secara tidak sadar melewati kekurangan. Berikut adalah beberapa cara untuk meningkatkan kualitas analisis diri:

  • Buat permintaan gabungan tanpa menunjuk pengulas dan kembalilah ke sana setelah beberapa jam untuk melihat hasil edit Anda.
  • Menekan kecenderungan alami Anda untuk membalik-balik perubahan, dan sebaliknya dengan sengaja melihatnya dari garis demi garis.
  • Ikuti daftar periksa: Apakah kode memenuhi standar desain? Apakah semua persyaratan bisnis terpenuhi? apakah ada tes untuk semua kemungkinan kasus penggunaan? dll.

Permintaan Kolam Besar


Jumlah komentar terhadap permintaan kumpulan berbanding terbalik dengan jumlah perubahan yang terkandung di dalamnya. Artinya, PR besar → sedikit komentar, PR kecil → banyak komentar.

Faktanya adalah bahwa pengulas tidak hati-hati mempelajari permintaan kumpulan besar, tetapi cenderung untuk menggulirnya untuk menyelesaikan pekerjaan lebih cepat. Ini bertentangan dengan tujuan tinjauan kode. Kadang-kadang kebalikannya terjadi ketika penulis tidak menerima komentar apa pun selama berhari-hari, karena pengulas takut untuk mulai meninjau terlalu banyak PR.

Pecahkan permintaan kolam menjadi potongan-potongan kecil yang masuk akal secara terpisah dari satu sama lain. Jadi, Anda akan membantu mempertimbangkannya dengan baik dan cepat.

Permintaan Kolam Renang Yang Tidak Jelas


Seringkali Anda ditawari permintaan kumpulan dengan deskripsi yang samar-samar atau tanpa itu sama sekali. Peninjau harus memahami arti perubahan, mencoba mengingat tugas yang dibahas di suatu tempat dalam rapat atau di pelacak bug. Karena itu, lebih baik memberikan informasi pendukung kepada PR:

  • Perubahan apa yang dikandungnya
  • Untuk memulai dengan file apa
  • Tautkan ke tugas di pelacak bug
  • Tangkapan layar jika ini semacam perubahan visual

Informasi ini akan memberikan konteks yang lebih baik untuk peninjau dan dengan demikian mempercepat peninjauan kode.

Tenggat waktu tidak ada untuk tinjauan kode


Salah satu cara untuk memperpanjang tinjauan kode selamanya adalah dengan tidak memasukkan tenggat waktu untuk pengulas. Tetapkan tenggat waktu yang wajar, misalnya:

  • Kode tinjauan harus diselesaikan dalam waktu 48 jam sejak pengiriman permintaan kumpulan.
  • Untuk perbaikan terbaru, periode adalah 30 menit.

Terima kasih sudah membaca! :)

All Articles