Nilai tinjauan kode muncul ketika tim dapat menjelaskan keputusan sebelum membahas implementasi. Ruang lingkup praktisnya adalah meninjau maksud, risiko, perilaku, pengujian, batasan keamanan, dan dampak operasional daripada memformat hal-hal sepele. Risiko utamanya adalah perubahan besar yang beragam menyembunyikan keputusan-keputusan penting dan menyia-nyiakan perhatian peninjau.
Klasifikasikan kegagalan sebelum memilih perbaikan: tinjauan kode
Kegagalan tinjauan kode dapat berupa penolakan, penundaan, penyelesaian sebagian, tindakan duplikat, pembacaan basi, atau koreksi manual. status tersebut tidak dapat dipertukarkan. Pertama-tama periksa kebijakan yang diterapkan di server dan transisi status yang dapat diaudit untuk menentukan apakah permintaan awal melewati batas yang tidak dapat diubah. Pesan kesalahan umum tidak cukup bukti untuk coba ulang.
Ikuti operasi melalui interupsi: tinjauan kode
Gunakan kasus berbentuk produksi ini: akses dicabut, pemilik tidak ada, atau permintaan berulang tiba setelah penyelesaian sebagian. Tangkap pengidentifikasi operasi, mulai status, upaya transisi, respons eksternal, dan hasil yang terlihat pengguna. Kemudian ulangi permintaannya. Jika upaya kedua dapat menimbulkan efek samping lain, pemulihan memerlukan idempotensi atau rekonsiliasi daripada tombol coba ulang yang lebih menonjol.
Pulihkan dalam urutan aman terkecil: tinjauan kode
Mulailah dengan tindakan paling tidak invasif yang memulihkan status yang dapat dipercaya. Lebih memilih melanjutkan, memutar ulang, merekonsiliasi, atau memberikan kompensasi sebelum pengeditan administrator luas. Pertahankan catatan yang gagal hingga penyebab dan dampaknya bagi pelanggan dipahami. Latihan yang menentukan adalah apakah tim dapat mengambil sampel perilaku gabungan dan membandingkan cacat yang lolos dengan tinjauan asli.
Amati hasil yang dialami pengguna: tinjauan kode
status infrastruktur dapat terlihat normal sementara perubahan besar yang tercampur menyembunyikan keputusan konsekuensial dan menghabiskan perhatian peninjau. Hubungkan hasil yang terlihat oleh pengguna dengan rilis, ketergantungan, dan transisi status yang memengaruhinya. Lacak pengecualian yang tidak dimiliki dan ulangi insiden; peringatan tanpa pemilik dan tindakan aman hanyalah kebisingan.
Peta keputusan: tinjauan kode
- Risiko. Sebutkan pemiliknya, catatan resmi, status yang diharapkan, dan respons saat ditolak untuk bagian tinjauan kode ini.
- Perilaku. Dokumentasikan transisi normal, satu transisi terputus, dan pemulihan aman terkecil.
- Tes. Lampirkan tes yang dapat direproduksi, tanggal hasil, dan peninjau yang menerima risiko yang tersisa.
- Batasan keamanan. status input, output, batas izin, dan kriteria penghentian sebelum menambahkan otomatisasi.
- Dampak operasional daripada memformat hal-hal sepele. Catat perilaku tindakan berulang dan bukti mana yang membedakan coba ulang dari duplikasi.
kasus batas: tinjauan kode
- Ketika nilai tercatat untuk risiko berubah setelah perilaku disimpan, sebutkan nilai mana yang menang dan bagaimana status yang kalah direkonsiliasi.
- Jika bukti pengujian tidak tersedia saat permintaan tinjauan kode sedang berlangsung, pertahankan konteks yang cukup untuk membedakan penolakan dan penyelesaian sebagian.
- Tindakan berulang yang melibatkan batas keamanan akan mengembalikan hasil yang ada atau mengekspos kemungkinan efek duplikat sebelum coba ulang.
- Perubahan yang ditolak terhadap dampak operasional alih-alih memformat hal-hal sepele harus membiarkan status resmi tidak tersentuh dan membuat catatan audit yang tidak mengungkapkan rahasia apa pun.
- Pemulihan harus memulihkan status terkecil yang dapat dipercaya terlebih dahulu, lalu memverifikasi hasil tinjauan kode yang terlihat terhadap catatan yang disimpan.
Ukur keputusan, bukan aktivitas: tinjauan kode
Lacak pengecualian yang tidak dimiliki dan akurasi tindakan yang ditolak. Sebelum mengumpulkan hasil untuk tinjauan kode, tentukan populasi, lingkungan, jangka waktu, dan pemilik setiap pengukuran. Aktivitas hanya berguna jika aktivitas tersebut memperjelas apakah hasil tinjauan kode yang dilindungi menjadi lebih aman atau lebih mudah untuk dipulihkan.
Tetapkan ambang batas penyelidikan untuk tinjauan kode terlebih dahulu. Tinjauan kegagalan dan pemulihan juga harus menyebutkan respons yang diizinkan, bukti yang diperlukan untuk menyelesaikan masalah, dan tanggal peninjauan berikutnya. Berhenti mengumpulkan data tinjauan kode ketika tidak lagi membedakan keberhasilan, penolakan, penundaan, duplikasi, atau pemulihan, atau ketika tidak lagi mengubah keputusan.
Sumber dan bukti lokal: tinjauan kode
Referensi utama ini mendokumentasikan perilaku platform yang relevan dengan tinjauan kode. Untuk tinjauan kode, referensi tersebut menetapkan terminologi dan batasan; mereka tidak memverifikasi implementasi lokal.
- Tentang Pemilik Kode
- Tentang pull request
- Meninjau Usulan Perubahan dalam pull request
- Yang Harus Diperhatikan dalam tinjauan kode
- Standar tinjauan kode
Setiap klaim tinjauan kode yang dapat dipublikasikan masih memerlukan bukti lokal bertanggal: konfigurasi, hasil pengujian, tangkapan layar, log, kueri, atau hasil pemulihan dari produk yang disebutkan. Tinjauan kegagalan dan pemulihan harus menjelaskan dengan tepat artefak mana yang mendukung setiap klaim penting.
Contoh InMyDraft terkait: tinjauan kode
InMyCitizen memberikan contoh lokal batas produk yang dapat diperiksa yang relevan dengan tinjauan kode. Katalog proyeknya mencatat detail implementasi berikut: Warga mengajukan permohonan, membayar jika diperlukan, dan melihat kasus mereka melewati tahapan alur kerja dengan referensi per aplikasi, persentase, dan riwayat lengkap.
Perbandingan antara InMyCitizen dan tinjauan kode sengaja dibuat sempit. Ini menunjukkan bagaimana satu produk membuat status dan bukti terlihat; hal ini tidak membuktikan bahwa setiap rekomendasi tinjauan kode telah diterapkan. Gunakan contoh InMyCitizen untuk meninjau tinjauan kode, bukan sebagai pengganti pengujian produk dalam cakupan.
Tinjau daftar periksa: tinjauan kode
- Identifikasi apakah permintaan tinjauan kode yang gagal ditolak, diterima, ditunda, atau diselesaikan sebagian.
- Pertahankan status terakhir yang dapat dipercaya sebelum mencoba perbaikan.
- Uji pengiriman duplikat dan ketergantungan yang tidak tersedia.
- Gunakan pengujian yang diizinkan dan ditolak, catatan audit, tanggal kepemilikan, catatan pemulihan, dan log yang disunting untuk memilih pemulihan aman terkecil.
- Ubah kegagalan yang diamati menjadi uji regresi atau kasus runbook yang dikelola.
Keputusan tinjauan kode siap untuk tahap berikutnya ketika orang yang bertanggung jawab lainnya dapat mereproduksi bukti, menjelaskan batas kegagalan, dan melakukan pemulihan tanpa bergantung pada ingatan penulis asli.
