Cara membuat ulasan kod anda menyeronokkan (dan tidak mengerikan)

Saya telah melakukan semakan kod saya secara adil. Secara adil, maksud saya banyak. Adakah anda pernah melakukan tinjauan kod ciri epik? Saya ada. Itu bukan pengalaman hebat, kerana pada saat fail ke-100 disemak, saya sudah keletihan melihat kod. Saya begitu dekat dengan hanya pergi "Yup, kelihatan baik untuk saya" dan kemudian memberikan persetujuan saya.

Tetapi itu bukan bagaimana tinjauan kod berfungsi. Sebaik sahaja anda memulakan, anda harus berpegang teguh dan menyelesaikannya hingga akhir. Sudah tentu, anda boleh berehat sebentar, tetapi kemudian anda mula kehilangan konteksnya dan harus bermula sekali lagi, seperti ini:

Walaupun begitu, saya melencong. Rasa sakit bukanlah perkara yang sepatutnya saya bicarakan.

Jadi bagaimana kita membuatnya, katakan, kurang mengerikan? Pertama, bahkan sebelum membuat permintaan tarik, dan bahkan sebelum kita memulakan pengkodan, kita harus menjadikannya sebagai titik untuk memecah ciri menjadi beberapa kepingan kecil yang bagus. Pembangunan dan penyebaran menjadi lebih cepat, kerana selalu lebih mudah menggunakan fitur mini daripada yang epik. Ini menjadikan tinjauan kod lebih mudah dan cepat dilakukan kerana perubahannya agak kecil.

Hebat! Saya harap anda menyukai artikel saya. Mari kita semua pulang ...

Tunggu, berhenti !

Itu mengenai bagaimana membuatnya kurang mengerikan, tetapi bagaimana membuatnya menyenangkan?

Menggunakan meme dalam tinjauan kod

Penafian: berikut adalah pemikiran saya sendiri dan bukan mengenai majikan saya.

Saya hanya mahu menyingkirkannya, kerana ini berpotensi menjadi topik kontroversi. Bagaimanapun, kami membuat ulasan kod kami ringan dengan menambahkan meme.

Saya dapat mendengar putaran mata anda dari sini! Dengarlah saya. Apa penjelasan yang lebih baik daripada memautkan kepada orang lain yang dengan senang hati menerangkannya?

Nada nada inilah yang menjadikannya senang bagi pengulas dan orang yang kodnya sedang disemak. Salah satu contohnya adalah "ruji" pertama dalam saya image wallet. Saya perhatikan bahawa Rubocop kehilangan beberapa ruang ganda dalam fail kami, jadi ketika seseorang mengemukakan permintaan tarik dengan banyak ruang putih, tidak ada masalah untuk memberi mereka doge.

Itu adalah gambar yang sederhana, namun mesejnya sangat berkesan. Saya ingat orang ketawa ketika melihatnya. Orang tidak mahu "doged" jadi semua orang lebih waspada dalam ruang kosong mereka.

Lebih mudah untuk membuka pencari, menyeret doge ke komen, dan mengirim, daripada hanya mengetik yang lama Please remove the extra whitespacedalam permintaan tarik (PR), terutama jika ada banyak doges.

Tidak boleh menjadi kebakaran?

Ia benar-benar boleh. Saya tidak mengatakan bahawa semua orang harus mengikuti pasukan kami. Itu sangat bergantung pada keperibadian pasukan. Umur kita rata-rata berusia enam tahun junior saya, yang bermaksud kebanyakan dapat berkaitan dengan meme. Ini akan menjadi cerita yang berbeza jika pasukan anda mempunyai usia rata-rata empat puluh (kecuali tentu saja, mereka adalah 4chan atau yang terkini dengan meme terbaru!).

Anda amat mengenali rakan sepasukan anda. Setelah beberapa bulan berada di antara satu sama lain (terutamanya kerana kami berpasangan hampir 100% masa), kami semacam mempunyai rasa humor antara satu sama lain. Ini membuat kami selesa melihat meme di PR kami dan hanya tertawa mengenainya (tentu saja menyelesaikan masalahnya).

Apa faedah yang anda dapat daripada meme?

Satu faedahnya ialah membuat semakan lebih cepat (sekurang-kurangnya untuk saya). Orang yang juga menghantar PR sebenarnya memahami apa yang perlu mereka lakukan dengan lebih pantas. Daripada membaca beberapa perkataan, anda melihat gambar - dan kita semua tahu gambar bercakap lebih kuat daripada perkataan. Berikut adalah beberapa contoh dari saya personal image walletâ„¢:

Apabila saya mengeluarkan gambar untuk pertama kalinya, saya menambah penerangan / penjelasan mengenai perkara yang perlu mereka lakukan / perbaiki. Yang di atas secara asasnya mengatakan membuang kod "warisan" di atas. Padamkannya. Hancurkannya!

Ini khusus untuk Ruby - pretzel dotpengendali pada dasarnya adalah jalan pintas untuk a try-catch. Saya hanya menyerlahkan coretan yang memerlukan pretzel dan tampal gambar ini. Cepat dan senang!

Kedua-dua ini saya gunakan secara bergantian dan berulang-ulang, PALING di Ruby di mana kita selalu menambah # frozen_string_literal: truekomen ajaib di bahagian atas fail. Dengan Rubocop yang menerajui, kita semakin kurang melihat Elsa dan Mr. Freeze. Mereka juga muncul untuk sebarang pemalar yang memerlukan pembekuan.

Ini cukup mudah (saya harap). Apabila rakan sekerja melihat ini, itu adalah petanda mereka mengalami kesalahan ketik. Saya biasanya menonjolkan kesalahan ketik juga sehingga cepat dan senang dilihat (dan diperbaiki).

Ini hanya sebilangan kecil daripadanya. Ingatlah, terlalu banyak sesuatu biasanyabukan perkara yang baik. Oleh itu, berhati-hatilah semasa anda menambah meme anda. Sebaiknya jangan menambahkan terlalu banyak meme, kerana kadang-kadang boleh mengganggu. Mencari keseimbangan nada yang tepat dan hanya menghantar mesej secepat mungkin adalah kaedah terbaik untuk menyelesaikan permintaan tarik.

Itu sahaja kalian

Kesimpulannya, itu terpulang kepada anda jika anda ingin bersenang-senang, atau hanya bersikap serius dan profesional di tempat kerja. Sebilangan mungkin menganggap meme tidak profesional - dan pasti, dalam urusan kerja formal mungkin. Seseorang boleh berpendapat bahawa permintaan tarik boleh atau merupakan perkara yang berkaitan dengan pekerjaan formal, tetapi saya rasa ia hanya berlaku jika anda menggunakannya untuk dokumentasi atau ulasan. Jika tidak, saya fikir ia adalah "kebebasan bersuara" (ya, menarik kad itu!) Dan harus diambil sebagaimana adanya.

Bagi saya, ini menyampaikan apa yang ingin saya sampaikan: hapus ruang kosong tambahan, perbaiki ejaan, beku pemalar, atau hapus garis atau garis kod. Saya tidak perlu banyak menaip, rakan sekerja saya tidak perlu membaca banyak perkataan berbanding sekumpulan kata lain, dan itu sedikit sebanyak meredakan suasana. Semua orang menang! Dengan itu, saya akan mengakhiri ini dengan satu lagi gambar saya: