Bagaimana seharusnya kontribusi untuk proyek sumber terbuka dikelola oleh pemilik?

12

Saat mengelola proyek sumber terbuka (menggunakan layanan seperti GitHub) bagaimana orang akan menanggapi hal berikut:

Seseorang telah dengan ramah mengirimkan tambalan untuk menambahkan fitur baru atau mengatasi masalah. Salah satu situasi berikut terjadi:

  • Kode sumber tidak memenuhi satu atau beberapa konvensi penamaan, dll.
  • Saya merasa bahwa kode sumber dapat ditingkatkan dengan cara tertentu. Mungkin efek yang sama dapat dicapai dengan sumber yang jauh lebih sederhana, atau mungkin fitur bermanfaat lainnya akan dibutuhkan.

Q1. Apakah saya dapat mengubah sumber yang dikirimkan? (apakah ini mungkin di GitHub?)

Q2. Haruskah semua pengiriman seperti itu ditolak sesuai dengan pedoman pengiriman?

Q3. Jika ya untuk Q2, bagaimana dengan ide yang sangat rapi yang diterapkan dengan buruk? Apakah dapat diterima bagi saya untuk terus maju dan membuat milik saya sendiri?

Saya ingin mendorong kontribusi tetapi pada saat yang sama penting untuk mempertahankan standar tertentu.

open-source github Lea Hayes
sumber

Jawaban:

7

Siapkan, jika Anda belum melakukannya, sebuah dokumen yang menggambarkan standar proyek. Pastikan untuk menguraikan semua yang Anda rasa penting ketika menyumbangkan kode untuk proyek Anda.

Kemudian, tanggapi orang yang menyediakan kode yang merinci bahwa Anda sangat menghargai kontribusinya, dan bahwa Anda ingin menyertakan tambalan itu, tetapi ada beberapa masalah. Berikan tautan ke dokumen dan kutip masalah khusus yang Anda lihat. Kemudian, minta orang itu untuk memperbaiki masalah dan mengirimkan kembali kodenya.

Jeremy Heiler
sumber
Saya pikir kernel linux memiliki semacam "perubahan yang perlu perbaikan" untuk skenario ini.
seppo0010
1
Dalam jangka panjang, itu akan menguntungkan proyek dan komunitas secara keseluruhan jika Anda membuat orang untuk meningkatkan pengiriman mereka sendiri. Tetapi benar-benar oke untuk mengimplementasikan kembali fitur Anda sendiri, asalkan Anda sopan tentang hal itu.
David Schwartz
1
Saya telah melihat beberapa proyek yang mengotomatisasi beberapa hal ini setiap kali Anda meminta tarikan.
Andrew T Finnell
Hanya sebuah catatan untuk mereka yang menggunakan GitHub, jika Anda memberi nama dokumen yang dirujuk di atas CONTRIBUTING, maka tautan ke dokumen ini akan ditampilkan saat mengirimkan permintaan tarik. Ini dapat membantu menghemat waktu dimuka jika orang dapat menyelesaikan masalah umum sendiri terlebih dahulu.
Michael Mior
2

Jika tidak terlalu banyak kontributor, dan kontribusi ini cukup berharga, Anda dapat menerima tambalan seperti apa adanya, dan kemudian, di komit berikutnya, menulis ulang bagian-bagian itu sendiri, atau memformat ulangnya untuk mengonfirmasi ke standar pengkodean. - Kemudian, setelah itu, Anda akan mengirim email ke kontributor, dengan tautan ke perbedaan perubahan yang Anda buat. Semoga kontributor akan mempelajari perbedaannya, dan mengirimkan tambalan yang lebih baik di lain waktu, yang tidak perlu Anda ubah.

Ini mungkin ide yang baik, jika Anda belum menulis Panduan Kontributor atau dokumen Gaya Pengkodean . Bahkan, Anda dapat melanjutkan dengan cara ini (menerima dan mengubah tambalan, tautan balik email ke diff) untuk sementara waktu, sampai Anda melihat kesalahan apa yang dilakukan sebagian besar kontributor. Dan kemudian Anda hanya memasukkan kesalahan-kesalahan itu dalam Panduan Kontributor dan Panduan Styling .

Jika Anda melakukan hal-hal dengan cara ini, jawaban untuk Q1-Q3 adalah:

  • T1: Ya, edit kiriman, dalam komit berikutnya
  • T2: Tidak berlaku (saya berasumsi Anda belum menulis pedoman apa pun)
  • T3: Ucapkan terima kasih dan tulis ulang :-) (Mungkin tidak ada gunanya menerapkan tambalan sama sekali, jika, dalam komit berikutnya, Anda menulis ulang sepenuhnya)
KajMagnus
sumber