Peninjauan Kode & Persetujuan

Peninjauan kode merupakan dasar penting pengembangan perangkat lunak modern. Peninjauan ini adalah pemeriksaan sistematis terhadap kode sumber oleh rekan kerja untuk menemukan dan memperbaiki kesalahan yang terlewatkan pada tahap pengembangan awal.

Tujuan utamanya meliputi:

• Meningkatkan Kualitas Kode: Menemukan bug, kerentanan keamanan, dan kekurangan desain sejak dini.
• Berbagi Pengetahuan: Menyebarkan pemahaman tentang basis kode ke seluruh tim.
• Pementoran: Pengembang senior dapat membimbing pengembang junior, dan semua orang belajar dari sudut pandang yang berbeda.

Di GitHub, proses peninjauan kode biasanya mengikuti langkah-langkah berikut:

1. Seorang penulis membuat Permintaan Pull (PR) dengan perubahannya.
2. Penulis menetapkan atau meminta peninjau.
3. Peninjau memeriksa kode dan meninggalkan komentar serta saran.
4. Penulis menindaklanjuti masukan dengan mengirim komit baru ke cabang PR.
5. Setelah puas, peninjau menyetujui perubahan tersebut.
6. Terakhir, PR digabungkan ke cabang utama.

Peninjauan kode yang baik bukan hanya tentang menemukan bug, tetapi juga meningkatkan kesehatan proyek secara keseluruhan. Saat meninjau, pertimbangkan:

• Kebenaran: Apakah kode melakukan hal yang seharusnya? Apakah ada kasus tepi?
• Keterbacaan: Apakah kode mudah dipahami? Apakah nama variabelnya jelas?
• Kemudahan Pemeliharaan: Dapatkah orang lain mengubah atau memperluas kode ini dengan mudah nantinya?
• Performa: Apakah ada ketidakefisienan yang terlihat jelas?
• Keamanan: Apakah kode ini menimbulkan kerentanan?

Sebagai peninjau, masukan Anda harus selalu membangun dan sopan. Ingatlah, Anda meninjau kode, bukan orang yang menulisnya.

Tips memberikan masukan:

• Bersikap spesifik: Tunjukkan baris kode yang tepat.
• Jelaskan 'Mengapa': Jangan hanya mengatakan 'ubah ini'; jelaskan *mengapa* hal itu perlu diubah.
• Sarankan solusi: Tawarkan pendekatan alternatif atau potongan kode.
• Bersikap baik: Gunakan bahasa yang sopan dan berprasangka baik.

GitHub menyediakan alat canggih untuk memperlancar proses peninjauan:

• Komentar Baris: Klik sebuah baris pada tab 'Berkas yang diubah' untuk menambahkan komentar secara langsung.
• Saran: Anda dapat mengusulkan perubahan kode tertentu yang dapat diterapkan oleh penulis dengan satu klik.
• Peninjauan Ringkasan: Di akhir, Anda dapat mengirimkan peninjauan ringkasan dengan status 'Beri komentar', 'Setujui', atau 'Minta perubahan'.

Saran sangat berguna untuk perbaikan kecil yang jelas:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Jika Anda adalah penulis Permintaan Pull, menanggapi masukan sangatlah penting. Hal ini menunjukkan bahwa Anda terlibat dan berkomitmen untuk meningkatkan kode.

Saat menanggapi komentar:

• Akui: Balas setiap komentar, meskipun hanya untuk mengatakan 'Poin yang bagus!' atau 'Sudah'.
• Buat Perubahan: Kirim komit baru ke cabang PR Anda. GitHub akan memperbarui PR secara otomatis.
• Selesaikan Percakapan: Setelah komentar ditindaklanjuti, tandai sebagai 'Selesai' di GitHub.
• Ajukan Pertanyaan: Jika Anda tidak memahami suatu saran, mintalah penjelasan.

Status 'Setujui' merupakan tanda jelas bahwa peninjau puas dengan perubahan dalam Permintaan Pull. Banyak repositori dikonfigurasi untuk mewajibkan setidaknya satu persetujuan (atau lebih) sebelum PR dapat digabungkan.

Persetujuan menunjukkan bahwa peninjau yakin kode tersebut:

• Memenuhi persyaratan.
• Ditulis dengan baik dan mudah dipelihara.
• Telah mengatasi semua masalah penting.

Inilah lampu hijau untuk integrasi!

Terkadang, Permintaan Pull memerlukan pekerjaan tambahan sebelum dapat digabungkan. Dalam kasus tersebut, peninjau dapat memilih 'Minta perubahan' sebagai status peninjauannya.

Status ini dengan jelas menyampaikan bahwa:

• Ada masalah penghalang yang perlu diselesaikan.
• PR tidak dapat digabungkan sampai perubahan tersebut dibuat dan peninjau memberikan persetujuan baru.

Gunakan opsi ini jika masalahnya signifikan dan membuat kode belum dapat diterima.

Untuk mendapatkan manfaat maksimal dari peninjauan kode, penulis dan peninjau sebaiknya mengikuti beberapa praktik terbaik:

• Buat PR yang Kecil: PR yang lebih kecil lebih mudah dan cepat ditinjau.
• Deskripsi yang Jelas: Penulis sebaiknya memberikan deskripsi PR dan konteks yang terperinci.
• Bertindak Cepat: Peninjau sebaiknya berusaha meninjau dengan cepat; penulis sebaiknya segera menanggapi.
• Otomatiskan yang Dapat Diotomatisasi: Gunakan pemeriksa kode dan pengujian otomatis untuk menemukan masalah sederhana sebelum peninjauan.
• Belajar dari Peninjauan: Anggap setiap peninjauan sebagai kesempatan untuk belajar dan berkembang.

Berdasarkan hal yang telah kita pelajari, manakah dari berikut ini yang dianggap sebagai praktik baik dalam berpartisipasi pada peninjauan kode?

Anda telah menjelajahi dunia peninjauan kode dan fitur persetujuan GitHub! Kita telah membahas alasan peninjauan penting untuk kualitas kode dan berbagi pengetahuan, alur peninjauan yang umum, serta unsur-unsur utama praktik peninjauan yang baik.

Ingatlah untuk selalu memberikan masukan yang membangun, memanfaatkan alat GitHub seperti saran, dan mengikuti praktik terbaik saat meninjau maupun menanggapi masukan. Persetujuan dan 'Minta perubahan' merupakan sinyal penting untuk mengelola PR Anda secara efektif.

Teruslah berlatih agar menjadi kolaborator yang berharga!