Tips Pull Request Github untuk Memudahkan Reviwer
Bismillahirrahmanirrahim.
Pada artikel ini saya ingin sharing tentang tips pull request github yang disukai oleh reviewer.
Disclaimer: Ini hanya preferensi saya, menurut pengalaman kerja untuk klien maupun kerja bareng sesama developer selama beberapa tahun terakhir.
Saya pingin share tips cara memikat klien dengan menunjukkan cara kita bekerja. Cara ini cukup efektif jika klien kita adalah senior programmer/developer. Yaitu cara membuat deskripsi Pull Request yang mempermudah reviewer (orang yang me-review kerjaan kita).
Ini salah satu Pull Request yang saya bisa contohkan:
https://github.com/nafiesl/dompet/pull/64
Pada deskripsi pull request itu ada:
- Description (rangkuman di Pull request ini kita mengerjakan apa)
- Checklist (apa saja yang kita lakukan di Pull Request ini)
- How to test on localhost (ini menghemat waktu reviewer buat me-review kerjaan kita)
- Screenshot atau lebih bagus lagi kalau kita buatkan rekaman video (ini mempermudah reviewer juga).
Tujuannya adalah:
- Menghemat waktu reviewer/senior developer untuk tahu di Pull Request ini kita ngapain (problemnya apa, solusinya apa)
- Mereka bisa cepat menangkap: mana yang sudah dan mana yang belum dikerjakan.
- Menghemat waktu mereka untuk cari tahu gimana cara me-review kerjaan kita (pasti mereka banyak kerjaan lain).
Saya yakin sih, reviewer pada seneng dengan pekerjaan yang seperti itu. Dengan model Pull Request seperti itu, saya dapat feedback yang bagus dari klien.
Cara kerja seperti ini pasti bisa diterapkan untuk developer yang kerja di kantor juga (tidak hanya kerja freelance). Tujuannya sama, menghemat waktu senior yang me-review kerjaan kita. Secara tidak langsung, ini jadi kontribusi positif bagi perusahaan. Proses review sebuah tugas bisa lebih efisien.
Jadi kalau di tempat kerjanya belum ada template Pull Request, bisa coba diusulkan. Mudah2an bermanfaat untuk temen-temen. Selamat mencoba.
Semoga bermanfaat, terima kasih.