Skip to content

Latest commit

 

History

History
86 lines (68 loc) · 4.45 KB

CONTRIBUTING.md

File metadata and controls

86 lines (68 loc) · 4.45 KB

コントリビューションについて

新たに翻訳する

  • 翻訳開始時に プルリクエストを上げる(タイトルとかで1行くらいコミットしておく)
    • それで排他制御の意味になる
    • タイトルは [WIP] を付けておく
    • また、進捗の可視化になったり、忙しくなって途中で止めた時に回収出来たりする
    • 完成したらWIPを外して中の人にレビューをお願いする
  • 基本的には1章単位で翻訳/PRする(1章が大きくて負担がきつい時は1節、2ファイルだけでも構わない.)
  • プルリクの指針、翻訳時の指針に従う

プルリクの指針

  • プルリクを上げた時点でライセンス条項に同意したものとする
  • コミットするファイルは翻訳文書だけで、生成されたHTMLファイルはコミットしない
  • その文書に含まれる用語のglossaryも翻訳する
  • 新たな用語を訳した時は対訳表(TranslationTable.md)も更新する
  • 翻訳を終えた後に最低でも1度全体を眺めて推敲する

翻訳のフォーマット

  • 英文をコメントアウトして、その直下に(空行を空けずに)和訳を書く
    • コメントアウト記号<!---->は英文とは別の行に挿入し、英文の行は変更しない
    • コメントアウト記号のインデントは英文と揃える
  • ソースコードブロック中のコメントは、元の英文を残して次の行に訳す
  • インラインのrustコード中のコメントも次の行に訳す。
  • 英文でコメントアウトされている行は空行とする。

Example

    Example

```rust
// comment
let a = b; // comment
```
<!--
Example
--><!--
    Example
    -->
    

```rust
// comment
// コメント
let a = b; // comment
           // コメント
```

翻訳時の指針

  • 敬体を基本とする
  • ソースコードブロック中のコメントはTODOやFIXMEなど、問題形式になっているもののみ敬体にする。
  • 用語の訳は対訳表に従う
  • 訳注を入れる際はインラインなら(訳注: ...)のようにし、別行なら > 訳注: ... のように囲み形式にする
  • 継続用法の関係代名詞やコロン(:)、セミコロン(;)など日本語と対応取りづらい文は無理に1文に詰めず、2文に分けてもよい。 また、継続用法の関係代名詞でも限定修飾のように訳してもよい(日本語でどちらの意味にも読み取れるため。英語のテストでないので読み手の好意的解釈をあてにしてよい。)
  • 英語だとit, thatなどの指示語が多用されるが日本語だと繰り返した方が自然なことが多いので無理に指示語を使わずに自然な方を使う
  • 逆にyou, your, we, ourなどの英語の文法上仕方なく出てくる人称代名詞は日本語には訳さない方が自然なことが多いので無理に訳に出さない。 特に、一般論を語る時のyouは 訳してはならない 参考 【雑談】"あなた"と訳さない"you" ~ einzelzelle

書式類

  • クォート(')やダブルクォート(")は鉤括弧(「」)にする
  • どんなに1行が長くなっても日本語の文の途中で改行しない。レンダリングで余計な空白が入ってしまう。句点()、最悪でも読点()の後で改行する。
  • ただし、rustコード中のコメントに関しては、80文字以上にならないよう、途中で改行する。
  • Markdownのマークアップ記法の前後は空白/空行を空けることを基本とするが、厳密でなくてもよい。
  • 句読点には、。を、感嘆符は全角のエクスクラメーションマーク()を、疑問符は全角のクエスチョンマーク()を用いる。
    • これらの記号の後にスペースは入れない(See Issue #82)。
  • 括弧は全角のを使用する。
    • ただし、「日本語(original English)」のように原語を示す場合に限り、半角の()を使用する(See Issue #82)。