PHPマニュアル 日本語版

このリポジトリは、PHPマニュアル 日本語版 のソースとなる docbook を管理するリポジトリです。

PHP マニュアルに間違いを見つけたら？

PHP マニュアルに間違いや問題を見つけた場合、メンテナンスの担当者(メンテナ) へ報告すると、修正などの対応が行われます。

メンテナへ報告する方法は複数ありますが、github で報告する場合、以下に示す方法に従い、Pull Request を送るか、issue で報告するかの対応をお願いします。

Pull Request を送る場合

マニュアルの日本語訳に問題があり、Pull Request を送ることで修正可能な場合は、以下のやり方で修正箇所を特定して Pull Request を送って下さい。

• A) たとえば、以下のページで間違いを見つけたとします。
  • https://www.php.net/manual/ja/oop5.intro.php
• B) 間違っている docbook を github 上で検索して特定する
  • 上記のページの一部分を github の検索窓に入力すると、docbook の候補が複数出てくるはずです。
    • 日本語で検索したほうが特定しやすいと思います。
  • 例: https://github.com/php/doc-ja/search?q=PHP+%E3%81%AB%E3%81%AF%E5%AE%8C%E5%85%A8%E3%81%AA%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%83%A2%E3%83%87%E3%83%AB%E3%81%8C%E6%90%AD%E8%BC%89%E3%81%95%E3%82%8C%E3%81%A6%E3%81%84%E3%81%BE%E3%81%99
• C) 上記で特定した docbook を修正し、Pull Request を出す
  • このリポジトリを fork し、修正する
  • または、docbook のページの鉛筆のアイコンをクリックし、修正を提案する
    • 例: https://github.com/php/doc-ja/blob/master/language/oop5.xml
• D) Pull Request の内容について
  • Pull Request を日本語で送っても全く問題ありません。
  • また、コミットログに日本語を書いても全く問題ありません。
    • 過去のコミットログは英語になっています
      • メンテナが英語版とコミットの粒度を合わせているから、という以上の理由はありません。

issue で問題を報告する場合

マニュアルに 「何かしらの問題があるが、修正方法がわからない場合」 は、issue に登録をお願いします

• 但し、既に報告された内容がないかどうか を必ず確認して下さい。
• 以下のような問題を登録することを想定しています
  • 未訳のドキュメントがあり、日本語訳を追加して欲しいという要望
  • 日本語版に関する既知の問題
    • ドキュメント化されていない機能がある、など
  • その他、日本語版で修正されていない問題があるものの、修正方法がわからないもの
• Pull Request と同じく、日本語で報告しても全く問題ありません。

メンテナに興味がある人へ

PHP マニュアルのメンテナは、以下を行います。

• 英語版のコミット を翻訳し、日本語版に反映させる
• このリポジトリの Pull Request や issue に対応する

PHP マニュアルのメンテナンスに興味がある方は、PHP マニュアル 日本語版について をお読み頂き、必要なアクションを取って下さい。

メンテナ向けの注意

元々 PHP Manual の docbook は git.php.net で管理されていましたが、php-src にバックドアを仕込むコミットがなされた事案が発生したことから、2021/03/29 より、github で直接管理されることになりました。

そのため、git.php.net にミラーするための特別な作法も不要になっています。github でソースコードを管理する作法で、もろもろ作業頂いて問題ありません。