Repositori publik mungkin sulit dinilai jika dibuka ke folder yang tidak dapat dijelaskan atau perintah pengaturannya sudah ketinggalan zaman. README yang ringkas mengurangi hambatan tersebut dan memungkinkan peninjau fokus pada kode dan keputusan.
Sertakan hal-hal penting
- Nyatakan apa yang dilakukan proyek tersebut dan untuk siapa.
- Cantumkan prasyarat dan langkah-langkah penyiapan yang diuji sesuai urutan yang harus dijalankan oleh kontributor baru.
- Jelaskan fitur utama, batasan yang diketahui, dan cara menjalankan pengujian atau melihat demo.
Periksa instruksi dari awal yang bersih
Ikuti langkah-langkah pengaturan Anda sendiri di checkout baru atau direktori sementara. Ganti jalur khusus mesin, hapus kunci pribadi dan data pribadi, dan pastikan perintah cocok dengan skrip repositori saat ini.
Tambahkan tangkapan layar atau catatan arsitektur hanya jika hal tersebut memperjelas pengalaman. Sebuah proyek kecil dengan instruksi yang akurat lebih berguna daripada proyek besar README yang penuh dengan klaim yang tidak didukung oleh kode tersebut.