diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a97c9b1..989e9c4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,10 @@ # 既存の翻訳を修正する -TBD。それっぽくどうにかして下さい +修正してプルリクエストを投げる。このとき、過去のバージョンにバックポート出来そうな場合は過去のものも更新する。 + +* typoや軽い言い回しの修正などは気軽に投げると気軽にマージされる +* 訳語の修正などは最初の訳の時点で既に議論されている可能性があるためある程度チェックされる（チェックした旨とリンクがあるとレビューが速くなります） # バージョンアップに対応する Rustがバージョンアップされるとこちらのレポジトリに @@ -34,23 +37,36 @@ Rustがバージョンアップされるとこちらのレポジトリに # プルリクの指針 * プルリクを上げた時点でライセンス条項に同意したものとする + + **機械翻訳などライセンスに違反する訳をプルリクエストしてはならない** * コミットするファイルは翻訳文書だけで、生成されたHTMLファイルはコミットしない * その文書に含まれる用語のglossaryも翻訳する * 新たな用語を訳した時は対訳表(TranslationTable.md)も更新する * 翻訳を終えた後に最低でも1度全体を眺めて推敲する # 翻訳時の指針 +## 書式類 -* 敬体を基本とする -* 用語の訳は対訳表に従う -* 訳注を入れる際はインラインなら（訳注: ...）のようにし、別行なら - `> 訳注: ...` - のように囲み形式にする * 英文をコメントアウトして、その直下に（空行を空けずに）和訳を書く + ただし、先頭が`%`で始まるタイトルだけは`rustbook`の制約の関係上、原文を直下に置く * 1パラグラフ単位で翻訳する * ただし、rustのコードブロック（バッククォート3つで始まる別行立てのもの）中のコメントについては行頭が`# //`になるようにして英文のコメントを含むコードをコメントアウトし、直下にコメントを翻訳したものを書く（See [Issue #13](https://github.com/rust-lang-ja/the-rust-programming-language-ja/issues/13)）。 + これは「rustの」コードブロックのみで、他のコードブロック、例えばtextなどでは`#`でコメントアウト出来ないので原文を削除して翻訳文書を書き入れる。 +* 標準ライブラリのリファレンスへのリンクは相対リンクのままとして、英語版から変更しない（後日標準ライブラリのリファレンスもリポジトリに入れる） +* クォート(`'`)やダブルクォート(`"`)は鉤括弧(`「」`)にする +* 句読点には`、。`を、感嘆符は全角のエクスクラメーションマーク(`！`)を、疑問符は全角のクエスチョンマーク(`？`)を用いる。 + + これらの記号の後にスペースは入れない（See [Issue #82](https://github.com/rust-lang-ja/the-rust-programming-language-ja/issues/82#issuecomment-191691762)）。 +* 括弧は全角の`（`と`）`を使用する。 + + ただし、「日本語(original English)」のように原語を示す場合に限り、半角の`(`と`)`を使用する（See [Issue #82](https://github.com/rust-lang-ja/the-rust-programming-language-ja/issues/82)）。 +* どんなに1行が長くなっても日本語の文の途中で改行しない。レンダリングで余計な空白が入ってしまう。句点(`。`)、最悪でも読点(`、`)の後で改行する。 +* ~~Markdownのマークアップ記法の前後は空白/空行を空けることを基本とするが、厳密でなくてもよい。~~ + 空白/空行を空けなくても処理出来るかはrustbookの気分にかなりよるので統一的に空白を空ける。 +* 訳注を入れる際はインラインなら（訳注: ...）のようにし、別行なら + `> 訳注: ...` + のように囲み形式にする + +## 日本語 +* 敬体を基本とする +* 用語の訳は対訳表に従う * 用語や厳密な意味論を話してる部分以外はある程度は意訳でよい * むしろ変に原文に忠実で、日本語として読みづらいよりも意味が伝わって日本語として分かりやすい方がいい。 + ただし元の英文の意味と異なる場合（誤訳の場合）は修正が入る @@ -59,15 +75,3 @@ Rustがバージョンアップされるとこちらのレポジトリに * 英語だとit, thatなどの指示語が多用されるが日本語だと繰り返した方が自然なことが多いので無理に指示語を使わずに自然な方を使う * 逆にyou, your, we, ourなどの英語の文法上仕方なく出てくる人称代名詞は日本語には訳さない方が自然なことが多いので無理に訳に出さない。 特に、一般論を語る時のyouは **訳してはならない** 参考 [【雑談】"あなた"と訳さない"you" ~ einzelzelle](http://einzelzelle.blogspot.jp/2014/01/blog-post.html) -* 標準ライブラリのリファレンスへのリンクは相対リンクのままとして、英語版から変更しない（後日標準ライブラリのリファレンスもリポジトリに入れる） - -## 書式類 - -* クォート(`'`)やダブルクォート(`"`)は鉤括弧(`「」`)にする -* どんなに1行が長くなっても日本語の文の途中で改行しない。レンダリングで余計な空白が入ってしまう。句点(`。`)、最悪でも読点(`、`)の後で改行する。 -* ~~Markdownのマークアップ記法の前後は空白/空行を空けることを基本とするが、厳密でなくてもよい。~~ - 空白/空行を空けなくても処理出来るかはrustbookの気分にかなりよるので統一的に空白を空ける。 -* 句読点には`、。`を、感嘆符は全角のエクスクラメーションマーク(`！`)を、疑問符は全角のクエスチョンマーク(`？`)を用いる。 - + これらの記号の後にスペースは入れない（See [Issue #82](https://github.com/rust-lang-ja/the-rust-programming-language-ja/issues/82#issuecomment-191691762)）。 -* 括弧は全角の`（`と`）`を使用する。 - + ただし、「日本語(original English)」のように原語を示す場合に限り、半角の`(`と`)`を使用する（See [Issue #82](https://github.com/rust-lang-ja/the-rust-programming-language-ja/issues/82)）。