...
| 概要 | 種別 | 説明 | 例(File/Issue/Pull Request) | 備考 | Status (Draft/Approved) |
|---|---|---|---|---|---|
| ヘッダは訳さなくてもよい | md | ページ内に目次を置く場合、アンカーの都合上、英語のままの方が手間がかからない。 和訳した各ヘッダーにリンク張るためには少しトリッキーな方法が必要だった。 | international_languages.md | ※特に決定事項というわけでもなさそうなので後ほどでご意見お聞かせください（チャットもしくはミーティングで）
| Approved(2020/08/18) |
| ヘッダは訳さなくてもよい | rst | 特にトリッキーなことをせずに日本語に変換できる場合は、分かりやすさを優先して翻訳する | Approved(2020/08/18) | ||
| 共通 | |||||
| rst |
日本語文章統一ルール
表記ゆれを防ぐために本WGが定める基本的な日本語文章のルールです。
...
| 概要 | 説明 | 例(File/Issue/Pull Request) | Status (Draft/Approved) |
|---|---|---|---|
コミットメッセージおよびPRのタイトルは“[ja_JP]” で始める | ログや一覧で見分けやすいように | [ja_JP] translate glossary.rst into Japanese · hyperledger/fabric-docs-i18n@127a41d | Approved(2020/08/18) |
| Issue/PRのタイトルはファイル名よりもドキュメントの階層を明記する | その方が実際のドキュメント構成とのマッピングがしやすく抜け漏れの確認も楽になる | Key Concepts >> Fabric chaincode lifecycle Draft | Approved(2020/09/01) |
PR投稿前のセルフチェックリスト
| 概要 | 説明 | 備考 | Status (Draft/Approved) |
|---|---|---|---|
| Translation Rulesに従っているか | 本ページのセクション全体を確認してください。 | Approved(2020/08/18) | |
| Hyperledger Fabric固有の単語に関して用語集に従っているか | https://github.com/linuxfoundation-jp/HL_Fabric_Doc-Jp | Approved(2020/08/18) | |
ドキュメントビルド時(make html)に、 追加のWARNINGメッセージが出ていないことを確認する | 自身の編集作業によって新たに発生したWARNINGはできる限り無くなるように対応してください。 - WARNINGを確認することで、特にrstファイルについて、デッドリンク含めたフォーマットミスはある程度気付くことができます。 - 些細なものもありますが全体数を増やさないことが、他のコントリビュータが自身の追加したWARNINGに気付くのを助け、全体の品質維持につながります。 ※注意事項: 数件のWARNINGは本家から引き継いで発生していますので（後述のWARNING一覧参照）、これらは無視してください。 | Approved(2020/08/18) | |
ビルド後に、自身が翻訳したページについてブラウザ等で参照し、 フォーマット崩れがないことを一通り確認する |
| Approved(2020/08/18) | |
1ファイルの翻訳につき1 commitとなっていること | レビューを受けて修正した場合でも、原則的にcommitは1つにまとめる。複数ファイルを翻訳した場合には、ファイルごとに別commitとする。 ただし、同様の修正を複数のファイルにわたって行う場合 (アンカーの修正など) などはこの限りでない。 | Approved(2020/08/18) |
本家から引き継いでいるWARNING一覧
release-2.2においては、本家から引き継いで以下のchecking consistency WARNINGが発生しています（2020年8月13日時点）。これらはどこからもリンクが張られていないために発生している警告となります。
...