Seorang pembangun membuka permintaan tarik yang menambah pengiraan diskaun pada perkhidmatan pembayaran. Ujian tersebut lulus dan perbezaannya pendek. Seorang pengulas meluluskannya dalam masa dua minit dengan "LGTM". Tiga bulan kemudian, seorang rakan sepasukan perlu menukar fungsi yang sama dan mendapati bahawa ia menggabungkan peraturan penetapan harga, pembundaran dan akses pangkalan data di satu tempat. Tiada siapa yang boleh mengatakan dengan yakin apa yang dibenarkan untuk dilakukan.
Ini adalah senario ilustrasi, bukan insiden yang didokumenkan. Ia menunjukkan apa yang perlu dihasilkan oleh semakan kod rakan sebaya apabila ia berfungsi sebagai aktiviti pembelajaran: seorang pengulas yang dapat melihat perubahan yang munasabah, mengenal pasti kebimbangan yang belum menjadi pepijat, dan menjelaskannya dengan cara yang boleh diambil tindakan oleh penulis.
Panduan ini adalah untuk peneraju pembolehubah kejuruteraan dan pengurus kejuruteraan. Ia menunjukkan cara mereka bentuk latihan semakan kod yang membina kemahiran itu dengan sengaja, dan bukannya berharap pengulas mengambilnya daripada barisan. Ia merangkumi masalah prestasi, jurang untuk didiagnosis, cara menstrukturkan persediaan dan amalan, satu contoh yang telah berjaya dan cara menyemak kemahiran yang dibawa ke ulasan sebenar. Minta jurutera kanan mengesahkan setiap kes, kecacatan dan kriteria sebelum anda menggunakannya.
Apakah latihan semakan kod?
Latihan semakan kod merupakan tugasan latihan berstruktur yang mana pembangun menyemak perubahan yang telah disediakan, menerangkan apa yang mereka temui dan mengapa ia penting, serta mendapatkan maklum balas tentang kualiti penjelasan tersebut. Ia berbeza daripada ulasan yang dilakukan oleh pasukan anda setiap hari. Perubahan dipilih terlebih dahulu, kebimbangan di dalamnya diketahui, dan tujuannya adalah untuk menambah baik pengulas dan bukannya untuk menghantar perubahan tersebut.
fakta Pantas
| Soalan | Jawapan pendek |
|---|---|
| Apakah tugasan itu? | Terangkan dapatan ulasan dan berikan maklum balas yang boleh diambil tindakan oleh penulis. |
| Apa yang anda skorkan? | Ketepatan dapatan dan betapa bergunanya penjelasan tersebut. |
| Adakah mengira kecacatan sudah memadai? | Tidak. Ulasan adalah lebih daripada sekadar kecacatan, jadi latihan yang hanya memberi ganjaran kepada kiraan pepijat melatih tabiat yang salah. |
| Apakah permintaan kognitif? | Analisis dan nilaikan reka bentuk, kemudian cipta cadangan yang lebih baik. |
| Siapa yang mengesahkan kes itu? | Pengurus kejuruteraan atau jurutera kanan yang memiliki pangkalan kod. |
| Apa yang tidak boleh diperbaiki oleh senaman? | Masa semakan, pemilikan yang tidak jelas dan tekanan untuk bergabung dengan cepat. |
| Macam mana awak tahu ia berkesan? | Perubahan baharu yang tidak kelihatan telah dikaji semula berdasarkan kriteria yang dipersetujui, serta susulan ke atas ulasan sebenar. |
1. Huraikan masalah prestasi
Mulakan dengan tugasan, dalam satu ayat: jika diberi perubahan, pengulas akan menerangkan apa yang mereka temui, mengapa ia penting dan apa yang boleh dilakukan oleh penulis mengenainya. "Menerangkan" ialah perkataan yang penting. Mengenal pasti isu adalah separuh daripada kemahiran. Menyebutkannya supaya rakan sekerja yang mempunyai pandangan berbeza dapat memahaminya, mempertimbangkannya dan bertindak adalah separuh lagi.
Penyelidikan mengenai semakan kod moden menyokong usaha melangkaui pencarian pepijat. Dalam satu kajian di Microsoft, Bacchelli dan Bird memerhati, menemu bual dan meninjau pembangun dan pengurus. Mereka mendapati bahawa mencari kecacatan masih merupakan motivasi utama untuk semakan, tetapi semakan kurang mengenai kecacatan daripada yang dijangkakan oleh orang ramai. Ia juga memberikan faedah lain, seperti perkongsian pengetahuan, kesedaran pasukan dan penyelesaian alternatif, dan para penyelidik menggambarkan pemahaman kod dan perubahan sebagai aspek utama semakan (Bacchelli dan Bird, ICSE 2013). Ia merupakan kajian tentang pasukan sebuah syarikat, jadi gunakannya sebagai alasan untuk mereka bentuk bagi pemahaman, bukan sebagai penilaian untuk pasukan anda.
Piawaian ulasan yang diterbitkan oleh Google menunjukkan perkara yang sama. Ia memberitahu pengulas untuk menyokong kelulusan perubahan sebaik sahaja ia benar-benar meningkatkan kesihatan keseluruhan kod, walaupun ia tidak sempurna, dan ia mengatakan bahawa ulasan boleh mengajar pembangun sesuatu yang baharu, jadi komen yang membantu seseorang belajar dialu-alukan (Amalan Kejuruteraan GoogleKedua-dua sumber menggambarkan semakan sebagai tempat di mana penilaian dilaksanakan dan diberikan. Itulah yang harus dilatih oleh latihan anda.
2. Diagnosis jurang pembelajaran dan konteks
Bandingkan tugasan tersebut dengan apa yang diamalkan dan dinilai oleh program semasa anda.
- Adakah amalan semasa menggunakan tugasan sebenar? Jika pengulas baharu belajar dengan membaca panduan gaya dan kemudian menyemak permintaan tarik langsung, mereka berlatih dalam kerja sebenar tanpa tempat yang selamat untuk melakukan kesilapan. Jika penilaian merupakan kuiz tentang etika semakan, ia mengukur ingatan tentang peraturan, bukan keupayaan untuk mengaplikasikannya pada perubahan.
- Apakah permintaan kognitif? Dalam taksonomi Bloom yang disemak semula, menilai sama ada reka bentuk itu kukuh dan menimbang keseimbangannya terletak pada tahap analisis dan penilaian, dan mencadangkan struktur yang lebih baik mencapai tahap penciptaan. Jika latihan anda hanya bertanya "apa yang dilakukan oleh kod ini?", ia berhenti pada pemahaman. Panduan kami untuk memadankan aktiviti pembelajaran dengan Taksonomi Bloom menunjukkan cara memadankan aktiviti dengan tahap.
- Adakah sesuatu selain kemahiran menghalang? Semak masa semakan, peralatan, pemilikan dan norma pasukan. Jika pengulas mempunyai masa lima minit untuk setiap permintaan pull, tiada latihan akan menghasilkan penjelasan yang bernas. Jika penulis menganggap setiap komen sebagai kritikan, pengulas akan melembutkan penemuan mereka sehingga mereka tidak berkata apa-apa. Laporkan punca-punca ini kepada orang yang boleh membetulkannya.
3. Persediaan, amalan dan maklum balas reka bentuk
Berikan setiap peringkat tugasan yang berasingan.
Penyediaan. Semak apa yang diperlukan oleh pengulas sebelum mereka mula: senarai semak semakan pasukan, prinsip reka bentuk yang menjadi asasnya dan cara membaca perbezaan dalam perkakasan anda. Pastikan ini berjalan mengikut rentak dan pendek. Semakan semula hanya mengesahkan prasyarat dan ia bukanlah bukti bahawa seseorang boleh menyemak.
Amalan. Gunakan perubahan yang disediakan dengan sebilangan kecil kebimbangan yang telah diutamakan daripada pelbagai jenis: pepijat ketepatan, masalah kebolehpelan seperti tanggungjawab campuran dalam contoh pembukaan, nama yang tidak jelas atau ujian yang hilang, dan beberapa kod yang tidak mengapa. Minta pengulas untuk menulis komen yang akan mereka tinggalkan, susun kedudukan kebimbangan dan nyatakan maklumat lanjut yang mereka mahukan. Pelajaran langsung CodeRefinery menunjukkan bentuknya: orang ramai membuka permintaan tarik yang mengandungi kesalahan taip kecil dan kesilapan yang lebih besar, kemudian menyemaknya sebagai rakan sebaya (CodeRefinery, Mengamalkan semakan kodBina kod anda sendiri daripada pangkalan kod anda supaya konvensyen dan pertukaran adalah nyata.
Maklum balas. Pautkannya dengan keputusan yang dibuat oleh pengulas. "Anda perasan masalah pembundaran tetapi komen anda mengatakan 'ini kelihatan salah' tanpa menyatakan input apa yang memecahkannya" adalah lebih berguna daripada "menemui 2 daripada 4".
Input langsung atau semakan tak segerak? Input langsung menambah nilai paling tinggi apabila sesuatu kebimbangan itu samar-samar dan pengulas belajar daripada mendengar jurutera kanan menyatakan sebab mereka membangkitkannya, atau membiarkannya. Semakan tak segerak sudah cukup untuk membandingkan komen dengan ulasan pakar yang diberi anotasi.
4. Gunakan contoh yang realistik
Ilustrasi. Seorang pengurus kejuruteraan harus mengesahkan kes dan kriteria jawapan sebelum digunakan.
Kes itu. Perubahan menambah pengiraan diskaun pada perkhidmatan pembayaran. Ia lulus ujiannya. Dalam satu fungsi, ia menggunakan peratusan dan diskaun tetap, membundarkan keputusan, menulis ke pangkalan data dan menghantar peristiwa. Ia mempunyai satu ujian, untuk diskaun peratusan tunggal.
Tugas itu. Pengulas menulis komen yang akan mereka tinggalkan, menyusun kebimbangan mereka dan menyatakan apa yang mereka perlu tahu sebelum meluluskannya.
Percubaan pertama. "Nampak baik, ujiannya lulus. Mungkin boleh bahagikannya?" Pengulas telah perasan sesuatu tetapi belum menyatakan apa, mengapa ia penting atau apa yang perlu dilakukan. Penulis tidak boleh bertindak berdasarkan perkara ini.
Maklum balas dan cuba semula. Fasilitator bertanya: apakah perubahan pada fungsi ini pada masa hadapan yang berisiko merosakkan? Apakah yang akan anda minta penulis tambahkan sebelum anda meluluskannya? Percubaan semula meminta komen khusus tentang setiap kebimbangan, berserta sebab dan cadangan.
Percubaan yang lebih kuat. "Fungsi ini menggunakan dua jenis diskaun, iaitu membundarkan, menyimpan dan menerbitkan peristiwa, jadi perubahan pada pembundaran boleh mengubah apa yang kita simpan dan apa yang kita terbitkan pada masa yang sama. Saya akan meminta peraturan penetapan harga untuk beralih kepada fungsi tulen yang boleh kita uji sendiri. Ujian tunggal hanya meliputi peratusan diskaun. Saya akan meminta diskaun tetap dan pesanan yang menjadikan jumlahnya sifar. Saya tidak pasti sama ada peristiwa itu bertujuan untuk diaktifkan apabila jumlahnya sifar, jadi saya akan bertanya kepada pengarang." Perhatikan bahawa komen ini menamakan kebimbangan, memberikan sebab, membuat cadangan konkrit dan menyatakan apa yang tidak diketahui oleh pengulas.
5. Menilai keupayaan dan merancang pemindahan
Bukti keupayaan ialah prestasi terhadap perubahan baharu yang belum dilihat oleh pengulas. Nilaikan ketepatan dapatan dan kegunaan penjelasan. Rubrik mudah menggunakan skala 0 hingga 2 bagi setiap kriteria:
| kriteria | Bukti yang boleh diperhatikan |
|---|---|
| Pelaksanaan tugas | Mencari kebimbangan yang berkaitan dalam perubahan dan merekodkan bukti untuk setiap satunya. |
| Penaakulan | Menerangkan mengapa setiap kebimbangan penting, menawarkan alternatif dan menyatakan perkara yang masih tidak menentu. |
| Sempadan | Mematuhi peraturan semakan pasukan dan meminta bantuan atau maklumat apabila tiada autoriti atau konteks. |
Sauh: 0 bermaksud tiada atau tidak disokong, 1 bermaksud sebahagian dengan peninggalan yang berkaitan, dan 2 bermaksud lengkap dan wajar berdasarkan kriteria yang dipersetujui. Takrifkan ralat kritikal secara berasingan, contohnya meluluskan perubahan dengan risiko kehilangan data, supaya skor keseluruhan yang baik tidak dapat menyembunyikannya. Sesuaikan kriteria dengan pengurus kejuruteraan; rubrik ini adalah cadangan permulaan, bukan standard kesediaan yang disahkan. Untuk maklumat lanjut tentang penaakulan pemarkahan, lihat panduan kami untuk mereka bentuk amalan interaktif dengan maklum balas yang berguna.
Rancang untuk pemindahan. Selepas latihan, semak sampel ulasan sebenar pengulas beberapa minggu kemudian, menggunakan kriteria yang sama. Bandingkan dengan garis dasar yang diambil sebelum latihan dan tentukan populasi dan masa terlebih dahulu. Lihat perubahan lain yang berlaku dalam tempoh yang sama, seperti alat semakan baharu atau perubahan kakitangan, sebelum mengkreditkan latihan tersebut.
6. Jalankan senaman secara langsung atau mengikut rentak anda sendiri dengan AhaSlides
Anda boleh menjalankan latihan dalam bengkel atau membiarkan pengulas menyelesaikannya sendiri. Dalam sesi langsung, tunjukkan perubahan yang disediakan dan gunakan slaid interaktif untuk perbincangan:
- Pilih Jawapan untuk "kebimbangan yang manakah akan anda bangkitkan dahulu?", dengan kebimbangan yang telah diutamakan sebagai pilihan. Tunjukkan spread sebelum anda mendedahkan kedudukan anda sendiri.
- Terbuka Berakhir untuk "tulis komen yang akan anda tinggalkan". Pengulas boleh membandingkan perkataan mereka dengan orang lain, yang mana kemahiran penjelasan ditunjukkan.
- Skala penilaian untuk "seberapa terukkah ini?", supaya kumpulan itu dapat melihat perbezaan penilaian dan membincangkan sebabnya.
Bagi pengulas yang tidak dapat hadir, urutan yang sama boleh digunakan mengikut rentak kendiri, dengan ulasan pakar beranotasi ditunjukkan selepas setiap respons. Anggap sebarang dakwaan tentang pelaksanaan kod, integrasi atau ciri AI sebagai tidak disahkan sehingga anda mencubanya dengan bahan anda sendiri.
Jika anda juga melatih pengulas tentang kod bertulis AI, lihat panduan pendamping kami di Latihan semakan kod yang dijana AICatatan itu adalah tentang pengauditan output yang dijana. Catatan ini adalah tentang cara orang ramai menyemak hasil kerja masing-masing dan bagaimana mereka menerangkan apa yang mereka temui.
Kekangan yang mungkin kekal
- Masa ulangkaji. Komen yang bernas mengambil masa lebih lama daripada "LGTM", dan tarikh akhir mendesak ke arah versi pendek.
- Norma pasukan. Jika maklum balas dibaca sebagai kritikan peribadi, pengulas akan melembutkan atau menggugurkan dapatan mereka.
- Perlindungan kes. Satu latihan menunjukkan beberapa jenis kebimbangan. Skor tidak menggambarkan penilaian pengulas secara umum.
- Pindahkan. Persembahan dalam bengkel tidak sama dengan persembahan dalam barisan yang sibuk, jadi semak juga ulasan sebenar.
Nyatakan perkara ini kepada penaja lebih awal dan rancang pembaikan berasingan. Latihan menambah baik apa yang boleh dilihat dan dijelaskan oleh pengulas. Latihan tidak mewujudkan masa atau norma.
Soalan lazim
Apakah latihan semakan kod?
Ia merupakan tugasan latihan yang disediakan di mana pembangun menyemak perubahan dengan kebimbangan yang diketahui, menulis komen yang akan mereka tinggalkan dan mendapatkan maklum balas tentang ketepatan dan kegunaan. Matlamatnya adalah untuk membina kemahiran pengulas, bukan untuk menghantar perubahan tersebut.
Bagaimanakah anda menilai sama ada penilaian pengulas telah bertambah baik?
Berikan perubahan baharu yang belum mereka lihat dan nilaikan dapatan serta penjelasan berdasarkan kriteria yang dipersetujui. Kemudian semak sampel ulasan sebenar beberapa minggu kemudian. Kuiz tentang peraturan ulasan hanya mengesahkan prasyarat.
Adakah semakan kod rakan sebaya terutamanya tentang mencari pepijat?
Mencari kecacatan masih merupakan motivasi utama, tetapi satu kajian di Microsoft mendapati bahawa ulasan kurang mengenai kecacatan daripada yang dijangkakan dan turut menyampaikan perkongsian pengetahuan dan kesedaran pasukan. Latihan reka bentuk yang memberi ganjaran kepada penjelasan dan pemahaman serta kiraan kecacatan.
Di mana untuk bermula
Pilih satu jenis perubahan yang sering diulas oleh pasukan anda. Tulis penyataan prestasi, minta jurutera kanan menyediakan satu perubahan dengan tiga atau empat kebimbangan yang telah ditetapkan, dan draf rubrik tiga kriteria dengan skala 0 hingga 2 dan senarai ralat kritikal. Lakukan percubaan dengan kumpulan kecil, kemudian bandingkan ulasan sebenar mereka yang seterusnya dengan garis dasar.
Untuk melihat bagaimana latihan semakan boleh dijalankan secara langsung dengan pasukan anda sendiri, dan digunakan semula mengikut rentak selepas itu, terokai AhaSlides.
