Spesifikasi
Contoh bagaimana menggunakan tabel spesifikasi semua kontributor dapat mengenali semua kontributor
Wajib
Proyek open source harus mencakup item wajib berikut untuk mendukung spesifikasi Semua Kontributor:
- Bagian "Kontributor" di situs terkemuka dari dokumentasi repositori proyek yang menyertakan daftar semua kontributor proyek
- Tujuannya adalah menggunakan situs dokumentasi proyek yang paling menonjol jika memungkinkan. Dalam banyak kasus, ini adalah file README pada proyek
- Consider using a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is unfeasible to use the README file to acknowledge contributions. Dalam hal ini, tautan utama ke file CONTRIBUTORS harus dimasukkan pada halaman README di bawah tajuk "Kontributor"
- Daftar harus diformat sebagai tabel dengan informasi berikut tentang kontributor proyek:
- Nama
- Tautan URL ke situs tempat lebih banyak informasi dapat dipelajari tentang kontributor. URL ini dapat ditentukan oleh kontributor atas kebijaksanaan proyek.
- Indikasi Kategori Kontribusi dalam format gambar teks atau ikon menggunakan Kategori Kontribusi dan / atau gambar emoji Kategori yang ditentukan (lihat di bawah).
- Tautan ke Kategori Kontribusi dalam format teks atau emoji menggunakan Kategori Kontribusi yang ditentukan dan / atau Kategori Kontribusi emoji.
- Daftar kontributor dapat tersebar di beberapa baris (masing-masing secara teknis menjadi tabelnya sendiri) sesuai kebutuhan.
- Urutan kontributor tidak material terhadap spesifikasi. Urutlah sesuai keinginan kamu.
- Proyek harus mendefinisikan kontributor sebagai mereka yang berkontribusi pada proyek di salah satu Kategori Kontribusi di setiap tingkat kontribusi. Spesifikasi ini, menurut definisi, termasuk semua kontribusi. Dalam kasus di mana proyek menyimpang dari Kategori Kontribusi atau memerlukan tingkat kontribusi spesifik untuk memenuhi kriteria sebagai kontributor proyek, proyek harus memberikan dokumentasi eksplisit tentang definisi yang memenuhi kriteria kontributor proyek dalam dokumen CONTRIBUTING atau dokumen publik terkemuka serupa di tingkat atas repositori proyek. Spesifikasi ini merekomendasikan terhadap pengecualian individu dari daftar Kontributor berdasarkan tingkat kontribusi yang dirasakan. Sebagai gantinya, proyek harus menggunakan indikator upaya dalam daftar yang tetap mencakup semua kontributor proyek pada setiap tingkat upaya. Jika digunakan, indikator upaya ini adalah kebijaksanaan proyek dan saat ini tidak ditentukan.
Kiat pro: Kamu bisa menggunakan bot @all-contributors 🤖 untuk mengotomatiskan kontributor yang mengakui proyek open source kamu ✨
Opsional
Proyek harus mempertimbangkan item opsional berikut sebagai bagian dari komitmen mereka terhadap spesifikasi Semua Kontributor:
- Avatar pengguna dapat dimasukkan dan direkomendasikan.
- Tautan opsional dari indikator Kategori Kontribusi ke kontribusi spesifik kategori dapat dimasukkan untuk memberikan informasi tambahan tentang kontribusi proyek sebagaimana dirinci dalam bagian di bawah ini.