Home

Hidenori Goto edited this page Jan 23, 2014 · 19 revisions
Clone this wiki locally

Symfony2ドキュメント 日本語リポジトリ

Symfony2ドキュメントの日本語翻訳リポジトリです。翻訳プロジェクトへはどなたでも参加いただけます。

翻訳の手順

ドキュメントの英語ソースは英語版リポジトリ、翻訳は日本語版リポジトリ です。

  1. (重要)作業前には、かならず英語版・日本語版リポジトリともに、最新の状態になっていることを確認してください。 特に英語版についてはファイルの更新が頻繁であるため、注意が必要です。

  2. 両方のリポジトリをcloneしてください。

    $ git clone https://github.com/symfony/symfony-docs.git
    $ git clone https://github.com/symfony-japan/symfony-docs-ja.git
  3. 英語版リポジトリを見て翻訳するファイルを選び、日本語リポジトリのissues にどのファイルを翻訳するか登録してください。(他の翻訳者との作業が重複しないようissuesへ登録します)

  4. ローカルの日本語リポジトリ側で、翻訳作業用ブランチを作成してください。 book/installation を翻訳する場合は、たとえば次のようにします。

    $ git checkout -b book/installation
  5. 日本語リポジトリにまだファイルがない場合は、英語版リポジトリと同じようにディレクトリを作り、英語版のファイルをコピーしてきて上書きで翻訳を開始してください。 日本語の翻訳ファイルがすでにある場合は、英語の差分を調べ、差分を適用してください。

    翻訳ファイルの先頭 には、翻訳が対象とする Symfony またはコンポーネントのバージョン、および翻訳日付を記入してください。

    .. note::
    
     * 対象バージョン:2.3以降
     * 翻訳更新日:2013/11/23
    

    また、翻訳したファイルの末尾にはSphinx形式のコメントで翻訳完了日、自分のGitHubアカウント名、翻訳対象とした英語原文ファイルのコミットIDを加えてください(この記述を元に、原文の更新の差分を調べます)。

    .. 2013/11/22 yourname eb6d21d376056d3eb8b7681333f763f482bfe9e1
    
    # 英語版のディレクトリにて、対象ファイルの最新コミットを調べる
    $ git log -- book/bundles.rst
    
    # 英語版のディレクトリにて、翻訳済みコミットID(手順に2で記入したもの)を元に差分を調べる
    $ git diff targetcommitidhash..HEAD -- book/bundles.rst
  6. 翻訳が終わったら、GitHubでpull requestを送信できるよう準備します。 GitHub上で日本語リポジトリをまだForkしていなければ、自分のGitHubアカウントへForkしてください。 Forkしたリポジトリ用のSSH URLを、ローカルの日本語作業ディレクトリでリモート設定します。

    $ git remote add (自分のアカウント名) git@github.com:(自分のアカウント名)/symfony-docs-ja.git
  7. 自分のアカウントのリポジトリへ、作業したブランチをプッシュします。

    $ git push (アカウント名) (ブランチ名)
  8. プッシュできたら、GitHubの自分のリポジトリの画面へアクセスすると、「Pull Request」ボタンが表示されます。「Pull Request」を押し、日本語リポジトリへの適用リクエストを送信してください。 この時、説明欄に最初に登録した Issue の番号で「resolves #100」のように書き込んで Issue と紐付けてください。

  9. 必要に応じて翻訳チームのメンバーが翻訳内容をレビューして、修正依頼をコメントします。特になければそのままマージされ、翻訳は完了です。修正依頼コメントがある場合は、ローカルの作業したブランチで修正して追加のコミットを行い、それを GitHub へ push すれば、修正分の追加 pull request を送信できます。

  10. 異なる翻訳を開始する場合は、完了したブランチとは別のブランチを作成して作業してください。

    # 一旦 master ブランチへ戻る
    $ git checkout master
    
    # masterを最新に
    $ git pull
    
    # 新しい翻訳ブランチ作成
    $ git checkout -b book/doctrine

翻訳担当など

参考資料等