Dapatkan ulasan sejawat untuk plugin baru saya?

8

Apa cara terbaik untuk mendapatkan pengembang WordPress yang berpengalaman, lihat plugin saya dan berikan kritik yang membangun? Saya telah menulis kode untuk menyelesaikan beberapa pertanyaan saya di situs ini, dan saya pikir itu bisa bermanfaat bagi orang lain juga. Namun, karena mereka menggunakan plugin WordPress publik pertama saya, dan saya telah melihat banyak contoh yang tidak terlalu bagus di direktori WordPress publik, saya ingin tahu "di mana saya berdiri", dan bagaimana saya dapat meningkatkan plugin saya. Saya telah membaca daftar praktik terbaik , dan masih perlu menerapkan beberapa di antaranya, tetapi saya juga ingin jawaban untuk pertanyaan yang lebih umum, "Apakah ini cara yang baik untuk menyelesaikan masalah ini?"

Saya baru saja membaca kembali diskusi terkait padawp-hackers (saya tidak menyadari bahwa para peserta juga sangat terlibat dalam situs ini, dan bahwa pertanyaan "praktik terbaik" adalah akibat langsung dari itu). Saya tidak yakin kebutuhan saya akan dicakup oleh sistem seperti itu, dan saya setuju dengan keprihatinan Paul :

Ketika saya membaca komentar asli pada utas ini minggu lalu saya berpikir tujuannya adalah untuk mengumpulkan proses peer review di mana pengembang plugin dapat menawarkan saran kepada pengembang plugin lain sebagai ulasan kode mereka. Saya awalnya mengambil saran ini sebagai sesuatu di sepanjang baris "Yah, kode Anda berfungsi tetapi rangkaian rutinitas yang Anda tulis ini akan lebih baik jika Anda terhubung ke filter WP ini dan mencoba teknik ini (lihat plugin xxx sebagai contoh) ". Tujuan saya adalah berbagi pengetahuan pengembangan plugin WP dan menjadikan pengembang plugin biasa-biasa saja menjadi pengembang yang lebih baik. Seperti saya sendiri.

Ini akan menjadi ruang lingkup yang berbeda dari melakukan review daftar poin demi poin, itu akan lebih merupakan "bimbingan". Tampaknya ada banyak orang yang mau melakukan ini, dan (bahkan lebih baik) banyak dari mereka berpartisipasi di sini di situs ini, jadi bagaimana kita dapat mengubah semua energi itu menjadi sesuatu yang konkret?

Contoh saya saat ini adalah tiga plugin yang saya tulis untuk menyelesaikan masalah "ukuran gambar" saya . Saya menulis komentar pengantar panjang untuk setiap plugin, yang (saya harap) membuatnya lebih mudah untuk memahami niat saya tanpa membaca kode lengkap. Apakah ada hal lain yang bisa saya lakukan untuk memudahkan orang lain melihatnya? Harap abaikan permintaan konkret saya saat ini. Tidak hanya itu terlalu dini untuk mereka, tetapi saya berubah pikiran dan tidak ingin merusak diskusi umum dengan situasi khusus saya.

Jan Fabry
sumber
Tampaknya ada beberapa coders plugin veteran di sini, jadi mengapa tidak bertanya di sini?
Raphael
2
@ Raphael: Saya baru saja melakukannya, bukan? :-) Tapi saya ingin menggeneralisasi pertanyaan saya, sehingga orang lain mungkin merasa berguna juga. Mungkin ada beberapa panduan umum yang bisa diikuti seseorang untuk membuat plugin mereka lebih mudah ditinjau.
Jan Fabry
4 tahun kemudian ... apakah Anda pernah bisa melepaskan plugin itu? Intinya menunjukkan bahwa mereka masih setengah jalan, tetapi tampaknya masih merupakan ide yang bagus.
moraleida
@moraleida Google adalah teman Anda - gist.github.com/janfabry
patrickzdb

Jawaban:

4

Cara termudah adalah pendekatan dua langkah:

  1. Lepaskan plug-in Anda ke publik. Setelah tayang, Anda akan mulai mendapatkan umpan balik dari pengguna akhir selain dari pengembang. Jika Anda ingin, lepaskan sebagai versi "beta" dan sangat menekankan itu dalam file readme.
  2. Meminta. Ada banyak pengembang WordPress veteran di mana-mana: di sini, di daftar WP-Hacker, di pekerjaan WordPress , menguntit @wordpress di Twitter, dll. Ini hanya masalah membuang plug-in Anda di luar sana dan meminta umpan balik.

Secara umum, ikuti langkah-langkah yang sama seperti Anda akan mendapatkan patch Core dilihat oleh pengembang:

  • Tulis itu
  • Dokumentasikan
  • Hubungi pengembang (baik secara luas melalui salah satu saluran di atas atau langsung jika Anda bisa) dan minta umpan balik

Sejauh mengubah jenis "bimbingan" yang terjadi di situs ini menjadi sesuatu yang lebih konkret, itu akan menjadi proses organik. Seperti yang telah Anda sebutkan, upaya untuk membuat semacam proses peninjauan plug-in sebelum benar-benar meninjau sesuatu tampaknya telah terhenti. Satu-satunya cara untuk mendapatkan apa pun dari tanah adalah untuk benar - benar mulai melakukannya. Jadi jangan hanya berbicara tentang menemukan pengembang veteran dan mendapatkan umpan balik, keluar, temukan, dapatkan umpan balik Anda, dan tulis bagaimana prosesnya.

Kemudian dapat diulang dengan plug-in dan pengembang masa depan. Tapi Anda harus mulai di suatu tempat ...

EAMann
sumber
Terima kasih balasannya. Satu hal yang menghalangi saya untuk langsung bertanya kepada Anda, Mike atau kontributor terkemuka lainnya di sini adalah bahwa saya tidak ingin memaksakan Anda dan "memaksa" Anda untuk melakukan sesuatu yang Anda tidak ingin lakukan, tetapi terlalu sopan untuk menurun. Dan mungkin lebih baik untuk mendapatkan umpan balik sebelum saya merilis plugin, untuk mencegah saya dan para penggunanya dari kemungkinan kebodohan.
Jan Fabry
1. Tidak bekerja untuk saya. Saya telah memiliki ratusan unduhan tetapi tidak satu pun suara di wordpress.org.
Raphael
@Raphael Vote di WordPress.org bukan umpan balik nyata untuk memulai. Fakta bahwa Anda belum mendapatkan keluhan atau menerima laporan bug berarti bahwa itu kemungkinan besar berhasil dan pengguna akhir Anda puas. Sekarang sudah ada di dalam repositori, lebih mudah bagi pengembang untuk mendapatkan dan melihat sumbernya. Pada titik ini, Anda harus beralih ke langkah 2 dan meminta pengembang veteran untuk melihatnya dan memberikan umpan balik.
EAMann
1

Setelah melihat sekilas pada https://gist.github.com/675437 saya melihat beberapa poin minor, kebanyakan tentang keterbacaan:

  • Tulis dokumentasi kode yang baik: Blokade ... dan sebaris komentar setiap kali ada sesuatu yang tidak jelas.
  • Membagi fungsi looong menjadi fungsi terpisah yang lebih pendek. Mereka lebih mudah dibaca dan dibahas dalam komentar pengulas.
  • Sejajarkan operator tugas Anda, tambahkan spasi putih di antara tanda kurung.
  • Panjang karakter 80 karakter! Eclipse masih belum bisa membungkus garis panjang. :(
  • Biarkan kode Anda »tetap«, simpan indentasi. Dari pada:

.  

public function checkUrl()
{
    if (is_404()) {
        // code
    }
}

… menulis …

public function checkUrl()
{
    if ( ! is_404() ) {
        return;
    }
    // code
}

Saya telah menulis plugin baru malam ini ... dan saya bertanya-tanya apakah saya dapat mengajukan pertanyaan Anda dengan tepat. Waktu yang tepat. :)

fuxia
sumber
Terima kasih atas komentar awal Anda. Mungkin saya sedikit terlalu dini, karena saya memang perlu melakukan edit menyeluruh untuk membuat kode sesuai dengan standar pengkodean sehingga lebih mudah untuk fokus pada konten. Poin bagus tentang aturan "pergi lebih awal untuk menyelamatkan indentasi", tapi saya berasumsi 4 ruang tambahan pada setiap baris dari contoh kedua Anda tidak disengaja?
Jan Fabry
Uhm, ya, Markdown mengubah format setelah daftar. Saya akan memperbaikinya.
fuxia
Terima kasih atas komentar Anda, tetapi saya membaca kembali diskusi asli pada daftar wp-hacker dan memutuskan untuk memperluas cakupan menghapus permintaan spesifik saya dari pertanyaan. Ini berarti jawaban Anda tidak lagi pas, mungkin Anda mungkin ingin menghapusnya.
Jan Fabry
0

Itu hanya membuat saya berpikir tentang Appscan: http://www01.ibm.com/software/rational/products/appscan/source/ ; http://www-01.ibm.com/software/rational/products/appscan/source/features/ uji coba versi ringan: http://www-01.ibm.com/software/awdtools/appscan/express/

Ini dapat melakukan php dan seseorang dapat memasukkan aturan tambahan di dalamnya untuk memeriksa hal-hal. Dengan cara itu suatu bagian dapat diotomatisasi (seperti beberapa praktik terbaik seperti dalam jawaban dari toscho), ia dapat memeriksa keamanan, standar pengkodean, optimisasi dll ...

Saya hanya mengatakan: jika alat dapat memeriksa 80% maka 20% cek untuk manual memeriksa guru akan lebih sedikit. Ini juga akan membantu untuk menghasilkan laporan kepatuhan untuk penggunaan plugin dalam perusahaan besar yang menuntut hal-hal semacam ini di sekitar kode tambahan.

Kami mengotomatiskan hal-hal untuk orang lain jadi mengapa tidak untuk diri sendiri?

edelwater
sumber