Berkontribusi
BERKONTRIBUSI
Provelopment Foundation membaik ketika orang yang memakainya menyampaikan apa yang mereka temukan. Anda tidak perlu menjadi pengembang untuk ikut ambil bagian, tidak perlu meminta izin, dan tidak diminta apa pun: repositorinya publik, dan halaman ini berbicara tentang apa yang berguna, bukan tentang apa yang diwajibkan.
Sebagian besar kontribusi dimulai dari sebuah masalah
Kontribusi yang berguna biasanya berawal dari seseorang yang menemui sesuatu pada pekerjaannya sendiri. Sebuah halaman berperilaku tidak seperti yang diharapkan; sebuah pengaturan tidak melakukan apa yang tersirat dari manualnya; satu kalimat dalam dokumentasi ternyata bermakna dua hal; sebuah langkah mengandaikan akses yang tidak Anda miliki. Semua itu adalah bahan mentah bagi proyek yang lebih baik, dan menjelaskannya dengan jelas sudah merupakan kontribusi tersendiri.
Anda tidak perlu memperbaiki apa pun untuk membantu. Keterangan yang tepat tentang apa yang Anda harapkan, apa yang sebenarnya terjadi, dan dokumen mana yang sedang Anda ikuti sering lebih bernilai daripada tambalan kode, karena keterangan itu memberi tahu pemelihara bagian tersebut apa sebenarnya pekerjaannya.
Cara ikut ambil bagian
Tidak ada satu pun yang wajib, dan tidak ada yang lebih tinggi kedudukannya dari yang lain.
- Pakai Foundation, lalu sampaikan apa yang Anda temukan
Terapkan, bangun sesuatu yang nyata, dan ceritakan apa yang berhasil dan apa yang tidak. Pengalaman dari situs yang sungguh berjalan adalah hal paling langka yang bisa diperoleh proyek yang masih muda.
- Laporkan masalah
Apa yang Anda harapkan, apa yang terjadi, dan bagaimana cara mengulanginya. Sertakan versi Foundation yang dipakai, halaman atau pengaturan yang terlibat, dan kalimat pesan yang muncul persis seperti aslinya — pengaturan yang salah ketik dan kerusakan yang sebenarnya terlihat berbeda dalam laporan.
- Usulkan perbaikan
Jelaskan masalah yang ingin diselesaikan, bukan hanya solusi yang sudah Anda bayangkan. Cara itu memberi ruang bagi pemelihara bagian tersebut untuk menyelesaikannya dengan cara yang sesuai bagi proyek.
- Perbaiki dokumentasi
Manualnya dibaca orang yang belum pernah melihat Foundation. Satu kalimat yang lebih jelas, satu prasyarat yang hilang, satu contoh yang dikoreksi, atau sebuah terjemahan semuanya langsung berguna bagi pembaca berikutnya.
- Sumbangkan pekerjaan teknis
Kode, pengujian, skema konfigurasi, atau contoh yang menyertai produk. Dokumentasi proyek di repositori menjelaskan bagaimana pekerjaan pengembangan dilakukan dan apa yang diharapkan menyertai sebuah perubahan sebelum diajukan.
- Tolong orang lain
Menjawab pertanyaan orang lain di tempat terbuka menolong semua orang yang nanti menghadapi pertanyaan yang sama, dan biayanya hanya waktu untuk menjawabnya.
Mengubah salinan Anda, dan mengubah proyek
Dua hal ini sering tercampur, padahal keduanya berbeda. Anda selalu boleh mengubah salinan Anda sendiri untuk keperluan apa pun, tanpa meminta izin. Apakah sebuah perubahan diterima ke dalam proyek adalah keputusan pemeliharanya, yang menimbang kesesuaiannya dengan arah proyek dan kemampuan yang tersedia. Penolakan satu usulan tidak mengurangi kebebasan Anda atas versi Anda sendiri.
Apa yang membuat laporan berguna
Sebagian besar kerusakan ditemukan oleh orang yang memakai perangkat lunaknya, dan laporan yang cepat ditangani biasanya memiliki beberapa sifat yang sama. Sifat-sifat itu perlu dituliskan, bukan karena proyek ini menuntut format tertentu, melainkan karena laporan yang lebih jelas menempuh jalan yang lebih pendek menuju perbaikan.
Sebutkan apa yang Anda harapkan dan apa yang terjadi. Jarak antara keduanya adalah kerusakannya. Pengalih bahasa tetap berbahasa Inggris setelah saya mengubah lokalnya menjelaskan sesuatu; situsnya rusak tidak menjelaskan apa pun.
Sebutkan di mana Anda berada. Versi Foundation yang dijalankan situs Anda, rute atau halaman yang terlibat, dan bahasanya bila masalah itu khusus bahasa tertentu. Kerusakan yang muncul pada satu bahasa saja adalah masalah yang berbeda dari yang muncul di semua bahasa.
Sebutkan apa yang Anda ubah. Apakah situs itu proyek Foundation yang baru atau sudah disesuaikan sangat menentukan: kerusakan pada platform dan kerusakan pada situs yang dibangun di atasnya adalah dua pekerjaan berbeda, dan keduanya layak dilaporkan.
Kutip pesannya secara tepat. Kalimat pesan kesalahan yang persis sering menjadi jalan tercepat menuju penyebabnya, dan parafrase justru menghilangkan bagian yang mengenali masalahnya.
Sebutkan apa yang sudah Anda coba. Itu menghemat orang lain mengulang pekerjaan yang sudah Anda lakukan, dan kadang menunjukkan bahwa dokumentasinya menuntun Anda ke tempat yang seharusnya tidak — yang merupakan kerusakan dokumentasi tersendiri.
Di mana aturan proyek ini sendiri berada
Bila Anda ingin menyumbangkan pekerjaan teknis dan bukan sekadar melaporkan sesuatu, repositori menyatakan harapan proyek ini, dan sebaiknya dibaca sebelum Anda meluangkan waktu pada sebuah perubahan. Aturan kerja untuk agen pengodean, dokumen arsitektur, dan manual validasi bersama-sama menjelaskan bagaimana kode ini dibangun, apa yang diharapkan menyertai sebuah perubahan, dan apa yang dibuktikan oleh gerbang validasinya — termasuk aturan proyek bahwa sebuah kemampuan tidak boleh diklaim melebihi tingkat yang benar-benar dibuktikan oleh penerapan dan pengujiannya.
Dokumen-dokumen itu adalah disiplin pemeliharaan proyek, bukan piagam komunitas. Isinya menjelaskan bagaimana kode ini dijaga tetap koheren, dan sekaligus jujur soal kapasitas: jumlah pemelihara tidak banyak, dan sebuah perubahan yang datang bersama pengujiannya sendiri, keterangan yang jelas tentang masalah yang diselesaikan, serta tanpa perubahan yang tidak berkaitan jauh lebih mungkin diterima daripada perubahan yang menyerahkan pekerjaan pemahamannya kepada orang lain.
Laporkan masalah, atau usulkan perubahan
Repositori publik adalah tempat masalah, usulan, dan perubahan yang diajukan dicatat.