翻訳協力フロー

Ato Araki edited this page Jun 22, 2014 · 11 revisions

翻訳にご協力いただける方は、ぜひ以下のフローでのご協力をお願いします。

翻訳対象のissueチケットに翻訳開始を宣言する

翻訳ステータスページに未翻訳ドキュメントのリストがあります。翻訳するドキュメントを選んだら、まず右側の「検索」ボタンを押して、該当のドキュメントのチケットが上がっていないか確認してください。チケットが上がっていれば、既に誰かが翻訳を始めています。チケットが上がっていなければ、未翻訳ドキュメントリストの右側の「翻訳します!」ボタンをクリックして、issueにチケットを追加してください。

ドキュメントを翻訳する

チケットを上げたら翻訳を始めてください。

gophersjp/goレポジトリ(このレポジトリ)のフォーク

翻訳を始めるにはまず、このレポジトリをフォークしてください。このページの右上にあるForkのアイコンをクリックしてください。自分のgithubアカウントにレポジトリをフォークできます。その後、フォークしたレポジトリをクローンします:

$ git clone https://github.com/account_name/go.git

account_nameの部分には自分のアカウントを名を入れてください。

gitレポジトリにブランチを作成

原則、masterブランチ上で作業を行わないようにしましょう。issueチケット番号のブランチを作成して、ブランチを切り替えます。例えば、issueチケットの番号が12だった場合には以下のようにします:

$ git checkout -b issue/12

翻訳対象ドキュメントのチェックアウト

次に、Goのレポジトリから翻訳対象となるGoのコード一式をチェックアウトします:

$ hg clone https://code.google.com/p/go

翻訳対象ドキュメントの最新化

上記のチェックアウトが済んでいる場合は、必ずpullコマンドで最新にしてください:

$ hg pull

翻訳対象ドキュメントをgitレポジトリにコピー

Goのレポジトリから翻訳対象のドキュメント(ソースコード)をgitレポジトリにコピーします。その際は、元のレポジトリと同じディレクトリ構成を保持するようにしてください。例えば、翻訳対象がgo/doc/root.htmlにある場合、root.htmlファイルをgitレポジトリのgo/doc/へコピーすることになります。

翻訳元ドキュメントタグの追加

翻訳対象ドキュメント内に、翻訳元のドキュメントへのタグを追加します。このタグによって、翻訳ステータスページで最新状態のチェックができるようになるので、かならずタグを追加するようにしてください。

  • htmlファイルの場合

冒頭の"Title"や"Path"タグのコメントの直後に以下のフォーマットのタグを追加します。

例:

<!--{
    "Title": "さあ、はじめよう",
    "Path":  "/doc/install"
}-->

<!--
本ドキュメントは以下のドキュメントを翻訳しています: https://code.google.com/p/go/source/browse/doc/install.html?r=1a3006bc130fc105665d49ecb95c72fc7820fa28
-->

ドキュメント例

  • docファイルの場合

ドキュメントのコメント部の最後に以下のフォーマットのタグを追加します。

例:

本ドキュメントは以下のドキュメントを翻訳しています: https://code.google.com/p/go/source/browse/src/cmd/go/doc.go?r=c4d996668981f0bd23d3a6be0fff72d09334b380
*/
package main

ドキュメント例

URLには、 https://code.google.com/p/go/source/browse/ 以下のリビジョン番号付きのURLを指定してください。issueチケットのリンク先の右側上部に表示されている16進数の文字列がリビジョン番号です。リンクの付いている番号をクリックすると一つ前のリビジョンになります。この状態で、その右側のリビジョン番号をクリックしてください。これで最新のリビジョンのURLがわかるはずです。このURLをコピーして貼り付けておきます。

翻訳の実施

翻訳の際は以下に従ってください。

翻訳に際し、質問や議論したいことがある場合には、翻訳対象のissueチケットに書き込んでください。

翻訳辞書への追加、翻訳辞書の内容について議論が必要と思われる場合は、翻訳辞書専用のissueチケットで質問してください。

表示の確認

GOPATH上にgophersjp/goのリポジトリをおいている場合、godocで簡単に確認できます。

使い方:

$ godoc -http=:6060

これでwebブラウザから確認できます。

*.go を翻訳している場合は、pkgにアクセスすると表示できます:

http://localhost:6060/pkg/github.com/gophersjp/go/

例: http://localhost:6060/pkg/github.com/gophersjp/go/src/cmd/5g/

*.html を翻訳している場合は、srcにアクセスすると表示できます:

http://localhost:6060/src/pkg/github.com/gophersjp/go/

例: http://localhost:6060/src/pkg/github.com/gophersjp/go/doc/asm.html

翻訳済みドキュメントのコミット、プッシュ、プルリクエスト

翻訳が完了したらドキュメントをコミットします。この際、コミットコメントに必ず翻訳対象のissueチケット番号を記述するようにしてください。例えば、翻訳対象がinstall.htmlで翻訳対象チケットの番号が12の場合には以下のようにします:

$ git add install.html
$ git commit -m 'add "Getting Started" document #12'

リモートレポジトリのブランチへプッシュします:

$ git push origin issue/12

この状態でgithubのレポジトリのトップページにアクセスし、上方のブランチ名の右側に表示される"Compare & pull request"をクリックします。任意でメッセージを入力し、"Send pull request"をでリクエスト送信します。運営メンバが内容をチェックしてマージを行います。問題なければ運営メンバがチケットをクローズします。