PHP
CakePHP
cakephp3

3分でできるCakePHP公式ドキュメントの誤訳を直す方法

More than 1 year has passed since last update.

お疲れ様です!
GMOリサーチの石黒です。

私は普段からCakePHP3の公式ドキュメントを翻訳しています。
今回は、既に翻訳された公式ドキュメントの誤訳やタイポを簡単に修正する方法をご紹介します。


必要なもの

  • Githubアカウント
  • ブラウザ

以上


①誤訳を発見する

Chronosのドキュメントを眺めていたら「インストールためには」という文を発見したので、今回はこれを「インストールするためには」に修正します。
※今回は明らかに誤訳というかタイポですが、誤訳であるかどうかは、英語の原文と見比べて判断しましょう。

image


②修正画面に飛ぶ

画面右の鉛筆マークをクリックすると、Githubで管理されているcakephp/docsというリポジトリの対象ファイルの修正画面に飛びます。

image


③修正する

image

この画面内で修正できます。
※画面上部にメッセージが出ているように、このリポジトリを直接修正することはできません。事前に自分のGithubアカウントでforkしておく必要があります。


④コミットする

コミットメッセージを入力してコミットします。
メッセージは何を修正したか分かれば良いです。
英語が望ましいです
が、日本人のコントリビューターもいますので、日本語でもOKです。
→コミットメッセージは単語を並べたレベルでも良いので英語が望ましいとのことです。

image


⑤プルリクエスト作成

コミットすると、自動でpatch-*というブランチが作られ、
プルリクエスト作成の手前の画面まで飛びます!

image

プルリクエストのタイトルを入れてプルリクエストを作成します。

image

作成されました。

image

image

裏でTravisCIが動いて、ビルドがOKかNGか返してくれます。
内容が合っていてビルドOKならきっとそのうちマージしてもらえます!