Menyumbang kepada PHP: Cara Menyumbang kepada Manual PHP '

Siri dua bahagian ini meneroka cara menyumbang kepada projek PHP, yang memberi tumpuan kepada dokumentasi dalam Bahagian Satu. Kami akan meliputi permintaan akaun dan langkah-langkah pasca kelulusan.

Mata utama:

Menyumbang kepada dokumentasi PHP meningkatkan bahasa dan meningkatkan kepakaran PHP anda. Ia juga boleh membawa kepada akaun php.net, mempengaruhi arah bahasa.
Dokumentasi menggunakan docbook xml; Kebiasaan membantu tetapi tidak wajib.
pemula boleh menggunakan editor dalam talian untuk patch mudah. Mengkaji garis panduan gaya terlebih dahulu adalah dinasihatkan.
penyumbang kerap atau mereka yang memerlukan pengeditan yang luas harus menubuhkan dokumen tempatan dan meminta akaun php.net. Ini melibatkan membuat direktori, mengkloning dokumen, dan mengkonfigurasi kata kunci SVN.
Sumbangan termasuk pembetulan pepijat, terjemahan, memperluaskan kandungan sedia ada, mendokumentasikan ciri -ciri tanpa dokumen, dan penambahbaikan umum.

Kenapa menyumbang?

php, menjadi sumber terbuka, berkembang maju dalam penglibatan masyarakat. Peningkatan penyertaan memberi manfaat kepada semua orang. Sama ada ia meningkatkan dokumentasi, menetapkan pepijat, atau menambah ciri, setiap jumlah sumbangan. Penyertaan aktif memperdalam pengetahuan PHP anda dan membolehkan anda meminta akaun php.net, membentuk masa depan bahasa.

Memahami dokumentasi PHP

Dokumentasi ini dalam Docbook XML. Pengetahuan terdahulu tidak diperlukan; Sintaks XML mudah dipelajari.

struktur direktori adalah:

Mengandungi alat untuk menukar dokumentasi XML.

memegang dokumentasi bahasa Inggeris (bahasa lain menggunakan kod dua huruf mereka). doc-base mengandungi direktori khusus lanjutan (fungsi untuk sambungan prosedur, folder bernama kelas untuk yang berorientasikan objek). Setiap folder sambungan termasuk en (halaman pendaratan) dan reference (maklumat versi). book.xml versions.xml Dokumentasi kini berasaskan SVN (walaupun berhijrah ke Git). Persediaan tempatan memerlukan kebiasaan SVN.

Penyumbang pertama kali

Mulailah dengan menggunakan editor dokumentasi dalam talian. Ini membolehkan log masuk dan penyerahan patch mudah. Penggunaan akaun yang konsisten memudahkan sumbangan penjejakan untuk aplikasi akaun php.net masa depan.

membiasakan diri dengan garis panduan gaya sebelum mengemukakan patch.

Contoh: Menyelesaikan Bug #71716

Pepijat ini melaporkan kelas klien MongoDB yang tidak betul dalam sampel. Selepas pengesahan, gunakan editor dalam talian untuk membetulkan ruang nama.

Video embed: https://www.php.cn/link/14AA36297925D3C82891D74FA28D7DF1

Persediaan Tempatan

editor dalam talian adalah terhad; Untuk sumbangan yang lebih besar, sediakan dokumen secara tempatan dan minta akaun php.net.

Buat direktori
1. . phpdocs
klon dokumen menggunakan SVN:
2. svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en
clone phd (alat rendering):
3. git clone http://git.php.net/repository/phd.git
klon laman web php.net:
4. ; Keluarkan git clone http://git.php.net/repository/web/php.git web-php dan buat pautan simbolik ke dokumen yang diberikan. web-php/manual/en
Konfigurasi kata kunci SVN dalam
5. : ~/.subversion/config *.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
(pilihan) Buat fail
6. dengan arahan untuk pengesahan, bangunan, dan melihat dokumen tempatan. ref

aliran kerja dokumen (tempatan) selepas persediaan, kemas kini repositori ( dan

). Edit fail XML yang berkaitan, sahkan menggunakan

, bina dengan PhD, dan mulakan pelayan setempat. Komited perubahan menggunakan SVN (svn up, merujuk nombor pepijat. Tutup laporan bug dari tab "Pemaju" selepas perubahan propagate. git pull php ~/phpdocs/doc-en/doc-base/configure.php svn ci -m "Resolve doc bug #...") meminta akaun php.net

Selepas persediaan tempatan, minta akaun php.net dengan docs karma. Walaupun tiada prasyarat yang ketat, menunjukkan sumbangan aktif adalah kunci. Hantar borang permintaan akaun dan e -mel phpdoc@lists.php.net menerangkan niat anda, nama pengguna Wiki, dan sumbangan masa lalu.

Tugas dokumentasi

Beyond Bug Fixes:

terjemahan

memperluaskan bahan yang didokumenkan sebahagian
Mendokumentasikan Ciri -ciri Undocumented
Penambahbaikan Umum
Petua Umum

Ikuti garis panduan gaya.

Aspek yang berkaitan apabila menetapkan pepijat.
Tulis dengan ringkas.
Kod contoh berasingan dari output.
Pastikan pesanan halaman yang betul.
Keluarkan php 4 rujukan.
Fail baru versi yang betul.
Rujuk senarai surat Soalan Lazim atau PHP-Docs untuk bantuan.
Kesimpulan

Bahagian ini meliputi dua aliran kerja: editor dalam talian dan persediaan tempatan. Bahagian dua akan meliputi penyumbang kepada teras PHP.

FAQS

(dipindahkan ke hujung untuk aliran yang lebih baik)

• Proses Menyumbang: Buat Akaun, Edit/Buat Kandungan, Terjemahan, Ikuti Garis Panduan.
• Kepentingan sumbangan: Meningkatkan kualiti dokumentasi, menyimpannya terkini, memupuk komuniti.
• Memastikan penerimaan: Ikut garis panduan, pastikan ketepatan dan kejelasan, dapatkan maklum balas.
• Sumbangan Bahasa Inggeris Bukan asli: Sumbangan adalah dialu-alukan; Terjemahan adalah sumbangan yang berharga.
• Kesilapan biasa: tidak mengikuti garis panduan, maklumat yang tidak tepat/tidak jelas, kekurangan proofreading, perubahan yang tidak perlu.
• Mendapatkan bantuan: Gunakan forum dalam talian, kumpulan perbincangan, garis panduan dokumentasi.
• Sumbangan Anonymous: mungkin, tetapi akaun digalakkan.
• kekerapan sumbangan: bervariasi berdasarkan ketersediaan dan minat.
• Pampasan: Secara amnya kerja sukarela.
• melaporkan kesilapan: Betulkan mereka jika penyumbang, jika tidak, laporkan kepada masyarakat.

ingat untuk menggantikan URL imej pemegang tempat dengan URL imej sebenar. Saya telah mengekalkan pemformatan imej dan menyimpan imej dalam kedudukan asalnya seperti yang diminta.

Atas ialah kandungan terperinci Menyumbang kepada PHP: Cara Menyumbang kepada Manual PHP '. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!