ホームページ > バックエンド開発 > PHPチュートリアル > PHPへの貢献:PHPのマニュアルに貢献する方法

PHPへの貢献:PHPのマニュアルに貢献する方法

Joseph Gordon-Levitt
リリース: 2025-02-15 12:25:12
オリジナル
808 人が閲覧しました

この2部構成のシリーズでは、パート1のドキュメントに焦点を当てた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ドキュメントを変換するためのツールが含まれています。 英語のドキュメントを保持しています(他の言語は2文字のコードを使用します)。 拡張固有のディレクトリ(手続き型拡張機能の関数、オブジェクト指向のフォルダー用のクラス名のフォルダー)が含まれています。 各拡張機能フォルダーには、

(ランディングページ)と

(バージョン化情報)が含まれています。

ドキュメントは現在SVNベースです(ただし、GITに移行しています)。 ローカルセットアップには、SVNの親しみやすさが必要です

初めての貢献者

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

オンラインドキュメントエディターを使用することから始めます。 これにより、OAUTHログインと簡単なパッチの提出が可能になります。一貫したアカウントの使用は、将来のPHP.NETアカウントアプリケーションの追跡貢献を簡素化します。 パッチを送信する前に、スタイルガイドラインに精通しています。

doc-baseen例:バグ#71716 referencebook.xmlの解決 versions.xmlこのバグは、サンプル内の誤って名前の付いたmongodbクライアントクラスを報告しています。確認後、オンラインエディターを使用して名前空間を修正します。

ビデオ埋め込み:https://www.php.cn/link/14aa36297925d3c82891d74fa28d7df1(必要に応じて実際の埋め込みコードと置き換えます)

ローカルセットアップ

オンラインエディターは限られています。より多大な貢献については、ドキュメントをローカルに設定し、PHP.NETアカウントをリクエストしてください。

  1. ディレクトリを作成します。phpdocs
  2. SVNを使用してドキュメントをクローンします:
  3. svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en
  4. クローンPHD(レンダリングツール):
  5. git clone http://git.php.net/repository/phd.git
  6. PHP.NET Webサイトをクローンします:
  7. ; git clone http://git.php.net/repository/web/php.git web-phpを削除し、レンダリングされたドキュメントへのシンボリックリンクを作成します。 web-php/manual/en:
  8. で構成します ~/.subversion/config(オプション)局所的にドキュメントを検証、構築、および表示するためのコマンドを備えた*.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URLファイルを作成します。
  9. refdocsワークフロー(ローカル)

セットアップ後、リポジトリ(および)を更新します。 関連するXMLファイルを編集し、

を使用して検証し、PHDでビルドし、ローカルサーバーを起動します。 SVNを使用して変更をコミットします(

、バグ番号を参照します。変化した後、「開発者」タブからバグレポートを閉じます。 svn upgit pullphp.netアカウントの要求php ~/phpdocs/doc-en/doc-base/configure.php svn ci -m "Resolve doc bug #...")

ローカルセットアップの後、docs karmaを使用してphp.netアカウントをリクエストします。 厳格な前提条件は存在しませんが、積極的な貢献を示すことが重要です。 アカウントリクエストフォームとメールを送信し、Phpdoc@lists.php.netにメールを送信します。意図、wikiユーザー名、および過去の貢献を説明してください。

ドキュメントタスク

バグの修正を超えて:

翻訳 部分的に文書化された材料の拡大

文書化されていない機能のドキュメント

    一般的な改善
  • 一般的なヒント
  • スタイルのガイドラインに従ってください。
バグを修正するときに関連する側面をチェックします。

簡潔に書く。

出力からの例の個別のコード。
  • 正しいページの注文を確認してください。
  • PHP 4参照を削除します
  • 適切にバージョンの新しいファイル。
  • 支援については、ドキュメントのFAQまたはPHP-DOCSメーリングリストに相談してください。
  • 結論
  • このパートは、オンラインエディターとローカルセットアップの2つのワークフローをカバーしました。パート2では、PHPのコアへの貢献について説明します
  • faqs
  • (より良い流れのために最後に移動)
    • プロセスの寄稿:アカウントの作成、コンテンツの編集/作成、翻訳、ガイドラインのフォロー。
    • 貢献の重要性:ドキュメントの品質を向上させ、最新の状態に保ち、コミュニティを育てます。
    • 受け入れを確保する:
    • ガイドラインに従って、正確性と明確さを確保し、フィードバックを取得します。 非ネイティブ英語講演者:
    • 貢献は大歓迎です。翻訳は貴重な貢献です。
    • 一般的な間違い:
    • ガイドラインに従わない、不正確/不明確な情報、校正の欠如、不必要な変更。
    • ヘルプの取得:オンラインフォーラム、ディスカッショングループ、ドキュメントガイドラインを使用しています。
    • 匿名の貢献:可能性がありますが、アカウントが奨励されています。
    • 貢献頻度:は、可用性と関心に基づいて異なります。
    • 補償:一般的にボランティア活動
    • 間違いの報告:貢献者がコミュニティに報告している場合は修正します。
    • プレースホルダーの画像URLを実際の画像URLに置き換えることを忘れないでください。 画像のフォーマットを保存し、要求に従って画像を元の位置に保持しました。

以上がPHPへの貢献:PHPのマニュアルに貢献する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート