這個分為兩部分的系列探討瞭如何為PHP項目做出貢獻,重點是第一部分的文檔。 我們將介紹帳戶請求和批准後步驟。
密鑰點:
了解PHP的文檔
文檔在DocBook XML中。 先驗知識並非嚴格必要; XML語法很容易學習。
> 目錄結構是:
>包含用於轉換XML文檔的工具。
保存英語文檔(其他語言使用其兩行代碼)。 >包含特定於擴展的目錄(程序擴展的功能,以對象為導向的文件夾的命名文件夾)。 每個擴展文件夾都包含
(版本化信息)。 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帳戶。創建
phpdocs
>使用SVN克隆文檔:svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en
>克隆PHD(渲染工具):git clone http://git.php.net/repository/phd.git
>克隆php.net網站:git clone http://git.php.net/repository/web/php.git web-php
web-php/manual/en
中的svn關鍵字:~/.subversion/config
*.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
(可選)創建一個ref
設置後,更新存儲庫(
和)。 編輯相關的XML文件,使用svn up
進行驗證,使用PHD構建,然後啟動本地服務器。 使用svn(git pull
,引用錯誤號碼)提交更改。在更改傳播後,從“開發人員”選項卡中關閉錯誤報告。 php ~/phpdocs/doc-en/doc-base/configure.php
。
svn ci -m "Resolve doc bug #...")
> 本地設置後,請求使用DOCS KARMA的PHP.NET帳戶。 儘管不存在嚴格的先決條件,但表現積極的貢獻是關鍵。 提交帳戶請求表並發送電子郵件至phpdoc@lists.php.net,以解釋您的意圖,Wiki用戶名和過去的貢獻。
>文檔任務超越錯誤修復:
translations
遵循樣式指南。
>該部分涵蓋了兩個工作流程:在線編輯和本地設置。第二部分將涵蓋PHP核心的貢獻。
>> FAQS
(移動到末端以獲得更好的流)以上是為PHP做出貢獻:如何為PHP貢獻手冊的詳細內容。更多資訊請關注PHP中文網其他相關文章!