com doc/ja: Update README.md / some minor tweaks, link to phpdoc gist.: README.md
[email protected] (Yoshinari Takaoka) Fri, 01 Jan 2021 07:24:20 +0000
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
Commit: 05ed8b1ce7824b6e0b2db1fe8356a2e511eb2dbc Author: Yoshinari Takaoka <[email protected]> Fri, 1 Jan 2021 16:24:20 +0900 Parents: eec3216ad5f166ff9762188fe062d07b0a79bcc8 Branches: master Link: http://git.php.net/?p=doc/ja.git;a=commitdiff;h=05ed8b1ce7824b6e0b2db1fe8356a2e511eb2dbc Log: Update README.md / some minor tweaks, link to phpdoc gist. Changed paths: M README.md Diff: diff --git a/README.md b/README.md index 2d143a6513..6a1f7ef84b 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,18 @@ http://git.php.net/?p=doc/ja.git PHP マニュアルに間違いを見つけた場合、メンテナンスの担当者(メンテナ) へ報告すると修正されます。 -メンテナへ報告する方法は複数ありますが、ここでは github 上で Pull Request を送る方法を示します。 +[メンテナへ報告する方法は複数あります](https://gist.github.com/mumumu/8464d879ccb939365d729cda242dbf14#php-%E3%83%9E%E3%83%8B%E3%83%A5%E3%82%A2%E3%83%AB-%E3%81%AB%E9%96%93%E9%81%95%E3%81%84%E3%82%92%E8%A6%8B%E3%81%A4%E3%81%91%E3%81%9F%E3%82%89)が、ここでは github 上で 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/bffc173b11c31f800e39141587b1f4f9d2fc8f95/language/oop5.xml + * または、docbook のページの鉛筆のアイコンをクリックし、修正を提案する + - 例: https://github.com/php/doc-ja/blob/master/language/oop5.xml ## メンテナ向けの注意 @@ -30,13 +31,14 @@ github で pull request を受け付けた場合、以下の手順で upstream - pull request URL に ".patch" を付け足す * 例: https://github.com/php/doc-en/pull/293.patch + - ここでは、英語版のマニュアルに対する、実在の Pull Request を例にしています。 - 上記の patch をダウンロードする * wget https://patch-diff.githubusercontent.com/raw/php/doc-en/pull/293.patch - patch をローカルで適用する * git am 293.patch - コミットメッセージに、自動クローズのメッセージを付記してコミットする * git commit --am - * コミットメッセージに "Closes php/doc-en#293" とする + * コミットメッセージに "Closes php/doc-en#293" を含める - git.php.net に push する * git push origin master * 上記のコミットメッセージが github にミラーされ、Pull Request も閉じられる