Panduan proyek

Templat CONTRIBUTING.md untuk repositori sumber terbuka

Berkas CONTRIBUTING.md membantu seseorang beralih dari “Saya ingin membantu” menjadi issue atau pull request yang berguna. Jelaskan kontribusi terkecil yang didukung dan cara memverifikasinya. Persyaratan harus mencerminkan cara kerja proyek yang sesungguhnya, bukan proses ambisius yang tidak diikuti siapa pun.

Tim editorial GitHubStart · Diperbarui

Salin dan sesuaikan templat kontribusi

Ganti penampung teks dan verifikasi setiap perintah serta tautan. Tetap sambut koreksi dokumentasi dan laporan bug meskipun kontributor belum siap mengubah kode aplikasi.

# Berkontribusi

## Sebelum memulai
Baca README dan periksa issue yang sudah ada.
Untuk perubahan besar, diskusikan pendekatannya sebelum menerapkannya.

## Penyiapan lokal
[Runtime yang diperlukan dan perintah penyiapan yang telah diverifikasi]

## Laporkan bug
Sertakan versi, lingkungan, langkah-langkah, hasil yang diharapkan, dan hasil aktual.
Hapus rahasia dan data pribadi dari log.

## Kirim pull request
- Jelaskan masalah dan perubahan yang diusulkan.
- Jaga agar perubahan tetap terfokus.
- Jalankan [pemeriksaan khusus proyek].
- Perbarui dokumentasi yang terdampak.

## Peninjauan
[Siapa yang meninjau, cara menanggapi, dan ketersediaan yang realistis]

## Cara lain untuk membantu
[Dokumentasi, contoh, terjemahan, atau laporan yang dapat direproduksi]

Buat panduan mudah ditemukan

GitHub mengenali panduan kontribusi di direktori akar repositori, docs, atau .github. Tautkan berkas tersebut dari README juga, agar pembaca pengantar proyek dapat langsung menemukan prosesnya.

Tinjau jalurnya dari titik masuk kontribusi yang sebenarnya pada repositori. Jika ada beberapa berkas panduan, selaraskan petunjuk yang bertentangan. Kontributor tidak seharusnya menerima satu perintah penyiapan di README dan perintah lain yang tidak didukung dalam panduan kontribusi.

Rancang satu kontribusi pertama yang mudah didekati

Pilih tugas kecil dengan hasil yang jelas, seperti memperbaiki contoh untuk runtime yang didukung. Jelaskan cara mereproduksi masalah, perilaku mana yang harus berubah, dan cara memeriksa penyelesaian. Jangan memberi label ramah pemula jika tugas tersebut bergantung pada pengetahuan internal yang tidak didokumentasikan.

Nyatakan ketersediaan Anda untuk meninjau dengan jujur. Jika tidak dapat menjanjikan waktu respons, jelaskan cara kontributor memeriksa statusnya. Batasan yang jelas mengurangi pekerjaan terbengkalai dan lebih berguna daripada janji untuk menggabungkan setiap kontribusi.

Pertanyaan umum

Apakah CONTRIBUTING.md menggantikan README.md?

Tidak. README menjelaskan proyek dan cara menggunakannya. Panduan kontribusi menjelaskan cara mengusulkan dan memverifikasi perubahan.

Haruskah saya menyalin perintah pengujian proyek lain?

Hanya jika perintah tersebut juga benar untuk proyek Anda. Ganti penampung teks dengan perintah yang benar-benar telah Anda periksa.

Apakah panduan kontribusi menjamin lebih banyak kontributor?

Tidak. Panduan mengurangi ketidakpastian bagi orang yang tertarik, tetapi kegunaan proyek, kualitas tugas, dan tindak lanjut pengelola tetap penting.

Referensi