Halo, Habr! Saya sajikan kepada Anda terjemahan artikel “6 Kiat Untuk Tinjauan Kode yang Sukses” .
Tinjauan kode selalu menjadi praktik mendasar untuk menciptakan kode yang bersih dan dapat dipelihara.
Seringkali, pengembang mengabaikan dan meremehkan ulasan kode untuk alasan yang tampaknya benar secara objektif pada saat itu.
Mari kita rumuskan 6 tips hari ini untuk melakukan tinjauan kode yang berkualitas dan bermanfaat .
I - Pilih Momen Yang Tepat
Tinjauan kode dimulai dengan memilih saat yang tepat .
Mari kita coba untuk menggambarkan karakteristiknya:
- Peluang rendah terganggu : Anda harus menghindari jam kerja, di mana, berdasarkan pengalaman, orang cenderung mengalihkan perhatian dari proses kerja. Memang, beberapa hari sering memiliki periode yang lebih tenang, dan hanya pada saat-saat seperti itu ada baiknya merencanakan tinjauan kode.
- Pikiran yang bersih dan jernih : Anda seharusnya tidak mengalami stres sebelum memulai peninjauan dan dalam proses, misalnya, takut pertemuan mendatang dengan pelanggan. Juga, programmer yang kodenya harus diperiksa harus dalam keadaan tenang sehingga tidak ada ketegangan di antara Anda yang dapat menghancurkan proses meninjau kode.
- Pengembang menjamin bahwa kode siap untuk verifikasi : tidak ada gunanya membuang waktu untuk melihat apa yang belum siap. Dengan kesiapan berarti kode berfungsi, tanpa praktik yang buruk, didokumentasikan, dan setidaknya tercakup oleh tes Unit. Berdasarkan pengalaman, jika seorang pengembang sendiri mengalokasikan waktu untuk tinjauan kode, maka ia lebih cenderung memberikan kode untuk verifikasi yang tidak membuatnya malu.
II - Tetapkan batas
Penting untuk memahami terlebih dahulu skala tinjauan kode yang akan datang.
Pertimbangkan satu atau lebih fitur? Mengingat waktu, apakah masuk akal untuk mempertimbangkan terlalu banyak?
Sebagai aturan, saya ingin fokus pada sejumlah perubahan untuk lebih memahami apa itu, dan tidak terlalu sering melompat di antara potongan kode.
Untuk mengatur batas tugas dengan benar, Anda dapat:
- Lakukan tugas yang ditugaskan dengan ukuran yang terlihat . Untuk melakukan ini, bagilah tugas-tugas besar menjadi kecil dan atomik, misalnya, di Jira atau bahkan di papan Scrum klasik.
- Prioritaskan validasi kode dengan benar : jika terlalu banyak tugas menunggu verifikasi, Anda tidak akan dapat melihat semuanya. Pilih prioritas.
III - Atur suasana yang tepat
Sebelum memulai tinjauan kode, buat suasana yang menguntungkan di sekitar Anda.
Apa yang diperlukan untuk ini?
- Jumlah minimum suara asing : Anda akan lebih produktif jika ada sesedikit mungkin kebisingan di sekitar. Lagipula, semakin kecil, semakin baik konsentrasinya.
- Tidak ada zona "interupsi" : mirip dengan apa yang dijelaskan di bagian pertama, ada baiknya menghindari saat-saat ketika mereka dapat melepaskan diri dari proses. Lebih mudah untuk melakukan ini di ruang yang terpisah.
- Zona kritik positif : mengkritik pekerjaan orang lain adalah proses yang kompleks. Tetapi bahkan lebih sulit untuk melakukan ini ketika ada banyak orang di sekitar. Di ruangan tertutup Anda bisa berbicara leluasa tanpa takut dikuping.
IV - Ngobrol, ngobrol, dan ngobrol lagi
Verifikasi kode bukan proses satu arah.
Peninjauan kode yang sukses sangat tergantung pada kemampuan untuk berkomunikasi secara hormat dan efektif dengan seorang kolega. Lagipula, tidak hanya inspektur yang menyatakan mana yang benar dan mana yang tidak.
Tinjauan kode adalah percakapan tentang segalanya: ruang lingkup, niat, koreksi, dan bahkan ketidaksepakatan.
Dalam prosesnya, cobalah mematuhi rekomendasi berikut:
- Tidak hanya mendengarkan, tetapi mendengar : pendapat dan pendapat sering berbeda, dan setiap perselisihan harus memunculkan diskusi yang konstruktif tentang masalah ini. Setiap sudut pandang membutuhkan perhatian.
- Nada netral : memeriksa kode bukan ujian atau Inkuisisi. Buatlah seolah-olah Anda datang untuk menilai kode, bukan orang yang menulisnya.
- Siksaan keraguan - tentukan : jika Anda tidak yakin tentang detail implementasi spesifik, tanyakan tentang hal itu. Beberapa niat yang tidak jelas pada pandangan pertama sering menimbulkan salah tafsir di masa depan.
V - Ingat tujuan akhir
Peninjauan kode harus mengarah pada hasil akhir: bisa berupa kritik yang membangun dan kiat untuk perbaikan atau integrasi kode dengan cabang pengembangan terkait yang dipilih dalam gitflow.
Ini adalah tanggung jawab peninjau.
Tetapi bagaimana Anda menilai apakah kode dapat diintegrasikan?
Berikut ini beberapa kriteria untuk membantu keputusan:
- Kode tertulis memecahkan masalah yang dijelaskan dalam pernyataan.
- Kode dicakup dengan benar oleh unit test .
- Konflik gabungan yang diselesaikan dengan benar.
- Tidak ada tanda-tanda yang jelas tentang bau kode atau praktik buruk .
VI - Gunakan alat khusus
Ada alat untuk verifikasi kode yang mudah. Anda dapat menggunakannya tanpa ragu untuk menyederhanakan proses peninjauan dan integrasi kode.
Tiga merek memimpin pasar perangkat lunak verifikasi kode: Smartbear (dengan Collaborator) , Perforce (dengan Helix Swarm) dan Atlassian (dengan Crucible)
Alat-alat tersebut sering menyediakan alat yang luas untuk mengatur tinjauan Kode, serta metrik untuk menjaga tim Anda terus meningkat.
Ini lebih dari sekadar alat untuk membandingkan kode, dan mereka berintegrasi dengan hampir semua sistem kontrol versi yang tersedia.
Cobalah!
Sekarang giliran Anda untuk berbagi!
Jika Anda memiliki kiat tambahan atau contoh spesifik yang terjadi pada Anda dalam kehidupan sehari-hari pengembang, bagikan dalam komentar.