Budaya Tinjauan Kode dan Praktik Terbaik PR

Tinjauan kode bukanlah cara untuk menghalangi orang — inilah cara tim belajar bersama, mengalihkan kepemilikan, dan menjaga kualitas tetap tinggi. Budaya tinjauan yang baik mengangkat seluruh tim; budaya yang buruk menciptakan hambatan dan rasa kesal.

1) Buat tetap kecil (di bawah 400 baris jika memungkinkan). 2) Tulis deskripsi yang jelas: alasannya, apa yang diubah, dan cara mengujinya. 3) Sertakan tautan ke tiket. 4) Tambahkan tangkapan layar atau video untuk perubahan antarmuka. 5) Tinjau sendiri perbedaan kode Anda sebelum meminta orang lain meninjau.

Gunakan awalan konvensional yang sama seperti pada komit: feat: add user profile page, fix: handle 404 in fetch wrapper, refactor: extract Avatar component. Banyak tim membuat catatan perubahan dari awalan-awalan ini.

Sebagian besar tim menggunakan templat PR — pasang di .github/pull_request_template.md.

Sebelum meminta orang lain meninjau, periksa perbedaan kode Anda sendiri baris demi baris. Tambahkan komentar yang menjelaskan pilihan yang tidak langsung terlihat alasannya. Sering kali Anda akan menemukan galat sendiri sebelum orang lain perlu menemukannya.

PR sepanjang 2000 baris jarang mendapatkan tinjauan menyeluruh. Bagilah menjadi: 1) pemfaktoran ulang (tanpa perubahan perilaku), 2) perilaku baru, 3) penyempurnaan antarmuka. Masing-masing lebih mudah ditinjau dan dikembalikan.

Sampaikan sebagai pertanyaan, bukan perintah: 'Bagaimana pendapat Anda jika ini diekstrak menjadi sebuah kait?' lebih baik daripada 'ekstrak ini'. Bedakan hal yang wajib diperbaiki dari hal yang sekadar bagus untuk ada. Gunakan awalan: nit:, question:, blocker:.

'Ini membingungkan' tidak memberi informasi apa pun kepada penulis. 'Saya harus membacanya 3 kali untuk memahami pengembalian awal — bisakah kita mengekstraknya menjadi klausa penjaga?' memberi mereka sesuatu yang dapat ditindaklanjuti.

Berikan komentar positif pada solusi cerdas, penamaan yang baik, dan pengujian yang membantu. Hal ini mendorong pola-pola tersebut sekaligus membuat umpan balik lainnya terasa lebih ringan. PR yang hanya mendapat kritik akan terasa seperti ajang pertentangan.

Prettier menangani pemformatan. ESLint menangani gaya. Jangan buang waktu tinjauan untuk memperdebatkan tab dan spasi. Jika aturan gaya terus dipermasalahkan, masukkan aturan itu ke pemeriksa kode.

Pengujian juga merupakan kode. Pastikan kode baru memiliki pengujian. Periksa apakah pengujian benar-benar menguji hal yang tepat — banyak pengujian tetap berhasil meskipun kode rusak karena memeriksa hal yang keliru.

Tanggapi setiap komentar — bahkan jika hanya dengan emoji jempol. Ajukan keberatan terhadap saran yang tidak Anda setujui (Anda yang menulis kodenya; mungkin Anda memiliki konteks tambahan). Tandai utas yang sudah selesai sebagai selesai. Perbarui deskripsi PR jika cakupannya berubah.

Lakukan tinjauan dalam satu hari kerja. PR yang terbengkalai kehilangan konteks — penulisnya sudah beralih ke hal lain dan cabangnya perlu diselaraskan ulang. PR besar yang dibiarkan selama seminggu selalu berubah menjadi penggabungan yang sangat menyulitkan.

Fitur saran GitHub memungkinkan penulis menerima perbaikan dengan satu klik. Jauh lebih cepat daripada menulis 'ubah baris ini menjadi X' dalam teks biasa.

Setujui ketika: kodenya benar, pengujian berhasil, Anda memahami perubahannya, dan perubahan itu aman untuk digabungkan. Menyetujui berarti Anda turut bertanggung jawab atas hasilnya. Jangan menyetujui secara otomatis — jika Anda belum membacanya, katakan demikian.

Bagaimana sikap yang disarankan saat memberikan umpan balik tinjauan kode mengenai sesuatu yang akan Anda tulis secara berbeda?

Penulis: PR kecil dengan deskripsi jelas, tangkapan layar, dan pengujian. Tinjau sendiri terlebih dahulu. Peninjau: berikan umpan balik yang membangun dan berbentuk pertanyaan. Bedakan penghambat dari hal kecil. Apresiasi hal-hal yang baik. Lewati persoalan gaya — biarkan alat yang menanganinya. Lakukan tinjauan dalam sehari. Setujui hanya jika Anda memahami perubahannya. Templat PR menstandarkan proses. Tinjauan adalah kolaborasi, bukan cara untuk menghalangi orang.