Contribution guideline
Directory structure
ドキュメントのディレクトリ構成は次のようになっています:
site/en-snapshot 以下にあるけれど site/ja 以下に無いものは、まだ翻訳が済んでいないドキュメントです。 それらを翻訳して site/en-snapshot 以下と同じ構成で site/ja 以下に配置して pull request を送ってください。
Pull request title
Pull request のタイトルは "JA: ..." とすることを推奨しています。 レビュアーが "JA" で検索することもあるので、見落としを防ぐためご協力お願いします。
Pull request size
1 ファイル 1 pull request 程度の大きさに分けて pull request を作成することを推奨しています。 これはレビュアーの負担を軽減して迅速にマージを行うためなので、ご協力お願いします。
Proofreading tool
一部レビューの自動化や多人数の翻訳による表記ゆれ対策として校正ツールを使用しています。 レビュー時にレビュアー側でも確認を行うので必須ではありませんが、予めチェックを行っておくと pull request の修正が少なく済みます。
また、校正ツールへの pull request も歓迎します。
Frequently asked questions
ソースコードのコメントは翻訳した方が良いですか?
基本的に翻訳する方針です。
どのドキュメントを翻訳すれば良いですか?
TF 1.0 の翻訳はアップデートの終了が宣言されたので TF 2.0 のドキュメントを翻訳してください。 また、次のディレクトリやファイルは対象外です。
/install/ディレクトリ/api_docs/and/versions/ディレクトリを含む API リファレンスナビゲーション:
_book.yamlと_toc.yamlというファイル概要を記したページ、とくに
_index.yaml,index.html,index.md/community/ディレクトリ (日本語話者向けのルールはこのCONTRIBUTING.mdに記します)
それ以外は特に制限はありません。
誰がどのドキュメントを翻訳中か確認できますか?
正確に把握することは難しいので、必要に応じて次のように確認してください:
"JA" で検索して現在作成されている pull request を調べる
心配であれば Slack 上などで呼びかける
どうすればレビュアーになれますか?
現在議論中ですが、次の条件を目安としています:
既に 1 つドキュメントを翻訳して pull request が取り込まれている
英語ドキュメント側が外部リポジトリへのリンクになっている場合はどうすれば良いですか?
リンク先のリポジトリと同じ構成で site/ja 以下に配置してください。