...
概要 | 説明 | 例(File/Issue/Pull Request) | Status (Draft/Approved) |
---|---|---|---|
コミットメッセージおよびPRのタイトルは“[ja_JP]” で始める | ログや一覧で見分けやすいように | [ja_JP] translate glossary.rst into Japanese · hyperledger/fabric-docs-i18n@127a41d | Approved |
Issue/PRのタイトルはファイル名よりもドキュメントの階層を明記する | その方が実際のドキュメント構成とのマッピングがしやすい | [ja_JP] Key Concepts » Fabric chaincode lifecycle | Draft |
PR投稿前のセルフチェックリスト
概要 | 説明 | 備考 | Status (Draft/Approved) |
---|---|---|---|
Translation Rulesに従っているか | 本ページのセクション全体を確認してください。 | Approved | |
Hyperledger Fabric固有の単語に関して用語集に従っているか | https://github.com/linuxfoundation-jp/HL_Fabric_Doc-Jp | Approved | |
ドキュメントビルド時(make html)に、 追加のWARNINGメッセージが出ていないことを確認する | 自身の編集作業によって新たに発生したWARNINGはできる限り無くなるように対応してください。 - WARNINGを確認することで、特にrstファイルについて、デッドリンク含めたフォーマットミスはある程度気付くことができます。 - 些細なものもありますが全体数を増やさないことが、他のコントリビュータが自身の追加したWARNINGに気付くのを助け、全体の品質維持につながります。 ※注意事項: 数件のWARNINGは本家から引き継いで発生していますので(後述のWARNING一覧参照)、これらは無視してください。 | Approved | |
ビルド後に、自身が翻訳したページについてブラウザ等で参照し、 フォーマット崩れがないことを一通り確認する |
| Approved | |
1ファイルの翻訳につき1 commitとなっていること | レビューを受けて修正した場合でも、原則的にcommitは1つにまとめる。複数ファイルを翻訳した場合には、ファイルごとに別commitとする。 ただし、同様の修正を複数のファイルにわたって行う場合 (アンカーの修正など) などはこの限りでない。 | Approved |
...