Cara membuat ulasan kode Anda menyenangkan (dan tidak mengerikan)

Saya telah melakukan ulasan kode yang adil. Dengan pembagian yang adil, saya sangat berarti. Pernahkah Anda melakukan peninjauan kode untuk fitur yang epik? Saya sudah. Itu bukan pengalaman yang luar biasa, karena pada saat file ke-100 ditinjau, saya sudah lelah melihat kode. Aku hampir saja mengatakan "Yup, terlihat baik bagiku" dan kemudian memberikan persetujuanku.

Tapi itu bukan cara kerja tinjauan kode. Begitu Anda mulai, Anda harus berpegang teguh pada itu dan menyelesaikannya sampai akhir. Tentu, Anda dapat beristirahat, tetapi kemudian Anda mulai kehilangan konteks dan harus memulai dari awal lagi, seperti ini:

Tapi saya ngelantur. Rasa sakitnya bukanlah yang seharusnya saya bicarakan.

Jadi, bagaimana kita membuatnya, katakanlah, tidak terlalu mengerikan? Pertama, bahkan sebelum membuat permintaan tarik, dan bahkan sebelum kita mulai membuat kode, kita harus memecah fitur menjadi bagian-bagian kecil yang bagus. Pengembangan dan penerapan menjadi lebih cepat, karena selalu lebih mudah untuk menerapkan fitur mini daripada yang epik. Ini membuat peninjauan kode lebih mudah dan lebih cepat untuk dilakukan karena perubahannya cukup kecil.

Bagus! Saya harap Anda menyukai artikel saya. Ayo pulang…

Tunggu, hentikan !

Itu tentang bagaimana membuatnya tidak terlalu mengerikan, tapi bagaimana kalau membuatnya menyenangkan?

Menggunakan meme dalam tinjauan kode

Penafian: berikut ini adalah pemikiran saya sendiri dan bukan tentang majikan saya.

Saya hanya ingin menyingkirkannya, karena ini berpotensi menjadi topik kontroversial. Bagaimanapun, kami membuat ulasan kode kami ringan dengan menambahkan meme.

Aku bisa mendengar gulungan matamu dari sini! Dengarkan aku. Penjelasan apa yang lebih baik daripada menautkan ke orang lain yang dengan senang hati sudah menjelaskannya?

Ini adalah nada yang membantu membuatnya menyenangkan bagi pengulas dan orang yang kodenya sedang ditinjau. Salah satu contoh akan menjadi "bahan pokok" pertama di saya image wallet. Saya perhatikan bahwa Rubocop kehilangan beberapa spasi ganda di file kami, jadi ketika seseorang mengajukan permintaan tarik dengan banyak spasi tambahan, tidak perlu dipikirkan lagi untuk memberi mereka doge.

Itu adalah gambar yang sederhana, namun pesannya sangat efektif. Saya ingat orang-orang tertawa ketika melihatnya. Orang-orang tidak ingin "dianiaya" sehingga semua orang lebih waspada di ruang kosong ekstra mereka.

Lebih mudah untuk membuka finder, menyeret doge ke komentar, dan memposting, daripada hanya mengetikkan yang lama Please remove the extra whitespacedi pull request (PR), terutama jika ada beberapa doge.

Tidak bisakah itu menjadi bumerang?

Benar-benar bisa. Saya tidak mengatakan setiap orang harus mengikuti tim kami. Itu sangat tergantung pada kepribadian tim. Usia kami rata-rata enam tahun lebih muda dari saya, yang artinya kebanyakan bisa berhubungan dengan meme. Lain ceritanya jika tim Anda rata-rata berusia empat puluh tahun (kecuali tentu saja, mereka adalah penghuni 4chan atau mengetahui meme terbaru!).

Anda paling tahu rekan satu tim Anda, sungguh. Setelah beberapa bulan bersama satu sama lain (terutama karena kami berpasangan hampir 100% dari waktu), kami bisa merasakan humor satu sama lain. Ini membuat kami nyaman melihat meme di PR kami dan hanya menertawakannya (sambil memperbaiki masalah, tentu saja).

Manfaat apa yang Anda dapatkan dari meme?

Nah, satu manfaatnya adalah membuat peninjauan lebih cepat (setidaknya untuk saya). Orang yang juga menyerahkan PR sebenarnya mengerti apa yang perlu mereka lakukan lebih cepat. Alih-alih membaca beberapa kata, Anda melihat gambar - dan kita semua tahu gambar berbicara lebih keras daripada kata-kata. Berikut beberapa contoh dari saya personal image wallet™:

Saat saya mengeluarkan gambar untuk pertama kalinya, saya menambahkan deskripsi / penjelasan tentang apa yang perlu mereka lakukan / perbaiki. Di atas pada dasarnya mengatakan hapus kode "warisan" di atas. Hapus. Hancurkan!

Ini khusus untuk Ruby - pretzel dotoperator pada dasarnya adalah jalan pintas untuk a try-catch. Saya hanya menyorot cuplikan yang membutuhkan pretzel dan menempelkan gambar ini. Cepat dan mudah!

Keduanya saya gunakan secara bergantian dan lagi, PALING di Ruby di mana kami selalu menambahkan # frozen_string_literal: truekomentar ajaib di bagian atas file. Dengan Rubocop di pucuk pimpinan, kami semakin jarang melihat Elsa dan Mr. Freeze. Mereka juga muncul untuk setiap konstanta yang perlu dibekukan.

Ini cukup mudah (saya harap). Jika rekan kerja melihat hal ini, itu tandanya mereka salah ketik. Saya biasanya menyorot kesalahan ketik juga sehingga cepat dan mudah dilihat (dan diperbaiki).

Ini hanya beberapa di antaranya. Ingat juga, terlalu banyak sesuatu yang biasanyabukan hal yang baik. Jadi berhati-hatilah saat menambahkan meme Anda. Sebaiknya Anda juga tidak menambahkan terlalu banyak meme, karena terkadang meme dapat mengganggu. Menemukan keseimbangan nada yang tepat dan hanya mengirim pesan secepat mungkin adalah cara terbaik untuk menyelesaikan permintaan tarik.

Itu saja, kawan

Kesimpulannya, terserah Anda apakah ingin bersenang-senang, atau tetap serius dan profesional di tempat kerja. Beberapa orang mungkin berpikir meme itu tidak profesional - dan tentu saja, dalam urusan kerja formal, meme mungkin saja. Orang dapat berargumen bahwa permintaan tarik dapat atau merupakan hal yang terkait dengan pekerjaan formal, tetapi saya pikir itu hanya berlaku jika Anda menggunakannya untuk dokumentasi atau ulasan. Kalau tidak, saya pikir itu adalah "kebebasan berbicara" (ya, tarik kartu itu!) Dan harus dianggap apa adanya.

Bagi saya, ini menyampaikan apa yang ingin saya katakan: menghapus spasi ekstra, memperbaiki ejaan, membekukan konstanta, atau menghapus baris atau baris kode. Saya tidak perlu mengetik banyak, kolega saya tidak harus membaca banyak kata dibandingkan kumpulan kata lain, dan itu sedikit meringankan suasana hati. Semua orang menang! Dengan itu, saya akan mengakhiri ini dengan salah satu gambar saya yang lain: