Skip to content

Commit 6168947

Browse files
authored
Merge pull request #61 from rust-lang-ja/update_readme
Update README and CONTRIBUTING
2 parents 39079fb + eeac984 commit 6168947

File tree

2 files changed

+62
-10
lines changed

2 files changed

+62
-10
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
+ また、進捗の可視化になったり、忙しくなって途中で止めた時に回収出来たりする
99
+ 完成したらWIPを外して中の人にレビューをお願いする
1010
* 基本的には1章単位で翻訳/PRする(1章が大きくて負担がきつい時は1節、2ファイルだけでも構わない.)
11-
* input.mdとソースコード`rs`ファイルがセットになっているので、同時に訳す
1211
* プルリクの指針、翻訳時の指針に従う
1312

1413
## プルリクの指針
@@ -19,26 +18,62 @@
1918
* 新たな用語を訳した時は対訳表(TranslationTable.md)も更新する
2019
* 翻訳を終えた後に最低でも1度全体を眺めて推敲する
2120

21+
## 翻訳のフォーマット
22+
23+
* 英文をコメントアウトして、その直下に(空行を空けずに)和訳を書く
24+
+ コメントアウト記号`<!--``-->`は英文とは別の行に挿入し、英文の行は変更しない
25+
+ コメントアウト記号のインデントは英文と揃える
26+
* ソースコードブロック中のコメントは、元の英文を残して次の行に訳す
27+
* インラインのrustコード中のコメントも次の行に訳す。
28+
29+
###
30+
31+
32+
````markdown
33+
Example
34+
35+
Example
36+
37+
```rust
38+
// comment
39+
let a = b; // comment
40+
```
41+
````
42+
43+
````markdown
44+
<!--
45+
Example
46+
-->
47+
48+
49+
<!--
50+
Example
51+
-->
52+
53+
54+
```rust
55+
// comment
56+
// コメント
57+
let a = b; // comment
58+
// コメント
59+
```
60+
````
61+
2262
## 翻訳時の指針
2363

24-
* markdownファイルは敬体を基本とする
25-
* rustファイル中のコメントはTODOやFIXMEなど、問題形式になっているもののみ敬体にする。
64+
* 敬体を基本とする
65+
* ソースコードブロック中のコメントはTODOやFIXMEなど、問題形式になっているもののみ敬体にする。
2666
* 用語の訳は対訳表に従う
2767
* 訳注を入れる際はインラインなら(訳注: ...)のようにし、別行なら
2868
`> 訳注: ...`
2969
のように囲み形式にする
30-
* markdownファイルの場合、英文をコメントアウトして、その直下に(空行を空けずに)和訳を書く
31-
+ ただし元の英文の意味と異なる場合(誤訳の場合)は修正が入る
32-
* ソースコード(`rs`ファイル)中のコメントは、元の英文を消して訳す
33-
* インラインのrustコード中のコメントも消去する。
3470
* [継続用法の関係代名詞](http://e-grammar.info/relative/relative_23.html)やコロン(`:`)、セミコロン(`;`)など日本語と対応取りづらい文は無理に1文に詰めず、2文に分けてもよい。
3571
また、継続用法の関係代名詞でも限定修飾のように訳してもよい(日本語でどちらの意味にも読み取れるため。英語のテストでないので読み手の好意的解釈をあてにしてよい。)
3672
* 英語だとit, thatなどの指示語が多用されるが日本語だと繰り返した方が自然なことが多いので無理に指示語を使わずに自然な方を使う
3773
* 逆にyou, your, we, ourなどの英語の文法上仕方なく出てくる人称代名詞は日本語には訳さない方が自然なことが多いので無理に訳に出さない。
3874
特に、一般論を語る時のyouは **訳してはならない** 参考 [【雑談】"あなた"と訳さない"you" ~ einzelzelle](http://einzelzelle.blogspot.jp/2014/01/blog-post.html)
39-
* 文書間のリンクは元文書では`/trait/derive.html`のようになっているが、これだとレンダリングした時にうまくリンクできない(カスタムドメインを使用していないため)。よって、`../../trait/derive.html`のように相対パスで指定する。ちょっとhackyなので注意。
4075

41-
### 書式類
76+
## 書式類
4277

4378
* クォート(`'`)やダブルクォート(`"`)は鉤括弧(`「」`)にする
4479
* どんなに1行が長くなっても日本語の文の途中で改行しない。レンダリングで余計な空白が入ってしまう。句点(``)、最悪でも読点(``)の後で改行する。

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,25 @@
1212
```bash
1313
$ git clone https://github.com/rust-lang-ja/rust-by-example-ja
1414
$ cd rust-by-example-ja
15-
$ cargo install mdbook --force
15+
$ cargo install mdbook
1616
$ mdbook build
1717
$ mdbook serve
1818
```
1919

20+
# テスト方法
21+
22+
```bash
23+
$ cd rust-by-example-ja
24+
$ cargo install mdbook-transcheck
25+
$ mdbook test
26+
$ git submodule init
27+
$ git submodule update
28+
$ mdbook-transcheck src-en src
29+
```
30+
31+
`mdbook test`はドキュメント内のソースコードがコンパイル可能かどうかを、
32+
`mdbook-transcheck`はコメントアウトされた原文とソースコードがオリジナルと一致するかどうかをテストします。
33+
34+
# 翻訳の仕方
35+
36+
[CONTRIBUTING](./CONTRIBUTING.md)を参照してください。

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy