diff --git a/README.md b/README.md index 26edd578a..0975e7c94 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repo contains the source code and documentation powering [react.dev](https://react.dev/). -> 以下はオリジナル（英語版）リポジトリの README です。日本語版 React ドキュメントへの貢献（翻訳・修正など）に興味がある方は [TRANSLATION.md](TRANSLATION.md) を参照してください。 +> 以下はオリジナル（英語版）リポジトリの README です。日本語版 React ドキュメントへの貢献（翻訳・修正など）に興味がある方は[こちらの Wiki ページ](https://github.com/reactjs/ja.react.dev/wiki)を参照してください。 ## Getting started diff --git a/TRANSLATION.md b/TRANSLATION.md deleted file mode 100644 index 29ff150b5..000000000 --- a/TRANSLATION.md +++ /dev/null @@ -1,66 +0,0 @@ -# reactjs.org 日本語翻訳プロジェクト - -このリポジトリでは React 公式ドキュメント日本語版に関する作業を行っています。経緯については以下のブログ記事をご覧ください。 - -- [Is React Translated Yet? ¡Sí! Sim! はい！](https://reactjs.org/blog/2019/02/23/is-react-translated-yet.html) - -オリジナル reactjs.org は Gatsby によって生成される静的サイトであり、英語ドキュメントおよびブログ記事が含まれています。本リポジトリはそのフォークです。`content` 内にあるドキュメントが日本語化されているほか（一部除く）、一部のレイアウト要素に対する JavaScript レベルでのいくつかのパッチ、日本語版でのみ使う textlint などが含まれています。現時点では大部分のドキュメントの翻訳が完了しているため、最新版ドキュメントへの追随を主に行っています。日本語訳や日本語版特有の問題を見つけた場合はこのリポジトリの Issue / Pull Request を使って報告ないし改善を提案してください。 - -メンテナ（3 名） - -- @potato4d -- @koba04 -- @smikitky - -## ドキュメント翻訳者向けガイド - -### 環境のセットアップ - -README.md にある通りですが、さらなる簡略版は以下の通りです。 - -1. Git, Node, Yarn をそれぞれ準備して ja.reactjs.org（のフォーク）をクローン -2. `yarn` で依存物をインストール（`yarn.lock` が更新された場合は適宜これをくり返す） -3. `yarn dev` でローカルウェブサーバーが立ち上がるのを確認 -4. `content` の中身の Markdown ファイルをテキストエディタで編集 -5. ブラウザで確認 - -### 作業の重複を防ぐための宣言 - -未翻訳記事の翻訳を行いたい場合は、他の人との作業の重複を防ぐため、https://github.com/reactjs/ja.reactjs.org/issues/4 での宣言をお願いします。 - -### スタイルの自動チェック - -日本語翻訳プロジェクト内では textlint というスタイルチェッカを利用しており、基本的なスタイルに関する問題（全角英数を使わない、句読点の統一など）の検出が行われます。コミットの際に自動で走りますが、`yarn lint:text` で手動で行うことも可能です。PR の作成の前には必ずエラーが出ないようにしてください。 - -### 全般的なこと - -- 見出しの行末にある `{#try-react}` のようなものは見出しアンカーなので、翻訳しない（[参考](https://github.com/reactjs/reactjs.org/issues/1608)）。 -- 「です」「ます」調で書く（箇条書きの中など特殊な文脈を除く）。 -- 原文と改行のしかた、空行の入れかたを厳密に一致させる。GitHub の差分表示画面で見て**行番号レベルで**左右が対応しているようにする。これは将来原文が更新された場合に Git が修正箇所を正しく対応づけるために重要（ただし極一部の記事では、原文に文の途中で改行が何度も含まれているものがあり、その場合はしかたがない）。 -- カッコは内部に和文を含む場合は全角、英数字のみ含む場合（特に原文の単語を示す場合など）は半角とする。 -- 半角開きカッコの前と半角閉じカッコの後には半角スペースを入れる。ただし別の約物と直接隣接している場合は不要。 - > ``` - > 避難ハッチ␣(escape hatch)␣を（必要に応じて）利用します。 - > ``` - -- 英数字と和文との間には半角スペースを入れる。ただし他の約物（特に句読点 。, 、）と直接隣接している場合は不要。 - - > ``` - > React␣の␣API␣で、`fooBar`␣を␣1␣回実行。 - > ``` - -- 和文内で文の一部として使う記号・約物類は原則全角とする。`「`, `」`, `、`, `。`, `：`, `！`, `？`, `／` などが該当する。 -- 用例の直前の行で行末に現れるコロンについても全角とする。ただしこれは毎回使うべきというわけではない。文が途切れる場合は `：` が必要だが、不自然にならないのであれば、句点（マル）で終えても構わない。 -- 英文から飛躍した意訳や表現の追加・改変を行わない。一方で分かりづらくなるような逐語訳もしない。 -- リンク先の URL は変えない（MDN などについては後でまとめて日本語版へのリンクに置換するかもしれませんが、まとめてやる方が間違いも少ないと思われるので、気にしないでいいです）。 -- コードサンプルについては原則翻訳しなくてよい。特に例の中の `banana` とか `Canada` のようなものまで翻訳する必要はない。ただしコード中のコメントに、（本来は本文に書いたほうがいいレベルの）大量の説明があり、翻訳しないと理解を妨げる危険性が高い場合は翻訳してもよい。 -- `*強調*` や `**強調**`（それぞれ `em` と `strong` に変換される）は、極力原文での使い方と同じにする（環境によって日本語フォントは斜体で表示できないため、`em` に日本語が含まれる場合は自動的に太字に変換されるようになっています：[参考](https://github.com/reactjs/ja.reactjs.org/issues/22)）。 -- ごく一般的な日本語表記に関して困ったら概ね公用文作成の要領などに準ずるが、カタカナ語の末尾の長音符については JIS Z 8301 の推奨に従う。そこまで目くじらを立てなくてよいが、基本は要するに以下の通り。 - - 3 音以上の場合のみ、片仮名語の末尾の長音符を原則省略。「エコー」「マナー」「ハンドラ」「プロパティ」など。 - - ただし「レンダー」だけは例外で、常に「レンダー」と伸ばす。 - - 補助動詞（～てください・～てみる・～ておく・～てくる・～てしまう、など）はかな書き。 - - 語彙化した副詞はなるべくかな書き。「ついに」「まれに」「ときに」「ようやく」「おそらく」など。 - -### 用語の統一 - -Wiki の[訳語の統一](https://github.com/reactjs/ja.reactjs.org/wiki/%E8%A8%B3%E8%AA%9E%E3%81%AE%E7%B5%B1%E4%B8%80)を参照。