首頁 > 後端開發 > php教程 > 為PHP做出貢獻:如何為PHP貢獻手冊

為PHP做出貢獻:如何為PHP貢獻手冊

Joseph Gordon-Levitt
發布: 2025-02-15 12:25:12
原創
808 人瀏覽過

這個分為兩部分的系列探討瞭如何為PHP項目做出貢獻,重點是第一部分的文檔。 我們將介紹帳戶請求和批准後步驟。

Contributing to PHP: How to Contribute to PHP's Manual

密鑰點:

  • 為PHP的文檔做出貢獻,可以增強語言並提高您的PHP專業知識。它還可以導致php.net帳戶,從而影響語言的方向。
  • >文檔使用docbook xml;熟悉是有用的,但不是強制性的。
  • >
  • 初學者可以將在線編輯器用於簡單補丁。 建議事先審查樣式指南。
  • >頻繁的貢獻者或需要大量編輯的人應在本地設置文檔並請求php.net帳戶。這涉及創建一個目錄,克隆文檔和配置SVN關鍵字。
  • >
  • 貢獻包括錯誤修復,翻譯,擴展現有內容,記錄無證功能和一般改進。
  • >
為什麼要貢獻? php是開源的,在社區參與方面蓬勃發展。 增加的參與使每個人都受益。無論是改進文檔,修復錯誤還是添加功能,每個貢獻都很重要。 積極參與加深您的PHP知識,並允許您請求PHP.NET帳戶,塑造該語言的未來。

了解PHP的文檔

文檔在DocBook XML中。 先驗知識並非嚴格必要; XML語法很容易學習。

> 目錄結構是:

>包含用於轉換XML文檔的工具。

保存英語文檔(其他語言使用其兩行代碼)。 Contributing to PHP: How to Contribute to PHP's Manual >包含特定於擴展的目錄(程序擴展的功能,以對象為導向的文件夾的命名文件夾)。 每個擴展文件夾都包含

(登錄頁面)和

(版本化信息)。 doc-base en該文檔當前是基於SVN的(儘管遷移到Git)。 本地設置需要SVN熟悉。 reference book.xml versions.xml首次貢獻者

首先使用在線文檔編輯器。 這允許OAuth登錄和提交簡單的補丁。一致的帳戶使用簡化了未來php.net帳戶應用程序的跟踪貢獻。

在提交補丁之前熟悉樣式準則。 >

>示例:解決錯誤#71716

>

此錯誤在示例中報告了錯誤的命名為MongoDB客戶端類。驗證後,使用在線編輯器糾正命名空間。

>嵌入視頻:https://www.php.cn/link/14AA36297925D3C82891D74FA28D7DF1

local設置

在線編輯器有限;有關更大的貢獻,請在本地設置文檔並請求php.net帳戶。

創建
    目錄。
  1. > phpdocs>使用SVN克隆文檔:
  2. > svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en>克隆PHD(渲染工具):
  3. > git clone http://git.php.net/repository/phd.git>克隆php.net網站:
  4. ;刪除
  5. 並創建指向渲染文檔的符號鏈接。 git clone http://git.php.net/repository/web/php.git web-phpweb-php/manual/en中的svn關鍵字:
  6. ~/.subversion/config *.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL(可選)創建一個
  7. 文件,並在本地使用命令進行驗證,構建和查看文檔。
  8. > ref
docs workflow(local)

設置後,更新存儲庫(

)。 編輯相關的XML文件,使用svn up進行驗證,使用PHD構建,然後啟動本地服務器。 使用svn(git pull,引用錯誤號碼)提交更改。在更改傳播後,從“開發人員”選項卡中關閉錯誤報告。 php ~/phpdocs/doc-en/doc-base/configure.phpsvn ci -m "Resolve doc bug #...")

請求php.net帳戶

> 本地設置後,請求使用DOCS KARMA的PHP.NET帳戶。 儘管不存在嚴格的先決條件,但表現積極的貢獻是關鍵。 提交帳戶請求表並發送電子郵件至phpdoc@lists.php.net,以解釋您的意圖,Wiki用戶名和過去的貢獻。

>文檔任務

超越錯誤修復:

translations
  • >擴展部分記錄的材料
  • 記錄無證件的功能
  • 一般改進
一般提示

遵循樣式指南。
  • 修復錯誤時檢查相關方面。
  • >簡潔地寫。
  • >與輸出單獨的示例代碼。
  • 確保正確的頁面訂單。
  • 刪除php 4參考。
  • 正確版本的新文件。
  • >請諮詢文檔常見問題解答或php-docs郵件列表以尋求幫助。
  • 結論

>該部分涵蓋了兩個工作流程:在線編輯和本地設置。第二部分將涵蓋PHP核心的貢獻。

>

> FAQS

(移動到末端以獲得更好的流)
  • > 貢獻過程:>創建一個帳戶,編輯/創建內容,翻譯,遵循指南。
  • 貢獻的重要性:提高文檔質量,保持最新狀態,促進社區。
  • >
  • 確保接受:遵循指南,確保准確性和清晰度,獲得反饋。
  • 非母語英語的人:歡迎貢獻;翻譯是一個有價值的貢獻。
  • 常見錯誤:不遵循準則,不准確/不清楚的信息,缺乏校對,不必要的更改。
  • 獲得幫助:
  • 使用在線論壇,討論組,文檔指南。 >
  • 匿名貢獻:
  • 可能會鼓勵帳戶。 貢獻頻率:
  • 根據可用性和興趣而變化。
  • 薪酬:通常志願者工作。
  • >
  • 報告錯誤:如果貢獻者,請糾正它們,否則向社區報告。
  • 記住用實際的圖像URL替換佔位符圖像URL。 我保留了圖像格式,並根據要求將圖像保持在其原始位置。 >

以上是為PHP做出貢獻:如何為PHP貢獻手冊的詳細內容。更多資訊請關注PHP中文網其他相關文章!

本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板