Skip to content

Latest commit

 

History

History
166 lines (118 loc) · 10.3 KB

CONTRIBUTING.md

File metadata and controls

166 lines (118 loc) · 10.3 KB
Raw

Vue.js 公式サイト日本語翻訳ガイド

ようこそ、Vue.js 公式サイト日本語翻訳リポジトリーへ！ 翻訳プロジェクトに貢献したい方は、以下の内容を一読の上、お願いします。

貢献方法

GitHub Issues にある本家ドキュメントの差分更新

英語版ドキュメントが更新されると、自動的に本リポジトリーにも issue が生成されるようになっています（説明文が New updates on head repo. となっているもの）。

  1. GitHub Issues から、このクエリー でソート & フィルターして、アサインされていない issues 一覧からできるだけ古いものからやりたい issue を選択します
  2. 選択した issue で、「対応します！」などのコメントで宣言します（vuejs-translations/docs-ja のメンテナーの方々は、GitHub の assign 機能で self assign で OK です）
  3. このリポジトリー vuejs-translations/docs-ja のメンテナーから同 issue でリアクションされたら、自分が選んだ issue の担当者として正式にアサインされたことになります
  4. このリポジトリーをフォークします！
    • README に従い、必ずパッケージをインストールしてください（textlint のため）
  5. main ブランチからトピックブランチを作成します: git branch my-topic-branch main
  6. 変更をコミットします: git commit -am 'docs: fix typo'
    • コミットメッセージは issue のタイトル（英語版のコミットメッセージ）と同じにしてください
  7. textlint で引っかかる場合は再度修正を行いコミットします
  8. フォークした自分のリポジトリーに Push します: git push origin my-topic-branch
  9. 問題がなければ、プルリクエストを vuejs-translations/docs-ja の main ブランチに送ります
  10. レビューで指摘事項があったら修正 + Push し、再レビュー依頼（ 🔄 ボタン）します
    • 依頼の前に、修正漏れがないか確認してください
  11. レビューで OK ならば、マージされてドキュメントに反映されます 🎉

Tips: より円滑な Pull Request のコメント記載方法

GitHub の Pull Request には、特定の記法を Pull Request の本文に書くことによって、該当 Pull Request のマージ時に自動的に対応する Issues をクローズできる機能があります。 Pull Request を送るときに、余裕があれば "resolve #123" といった形で、該当する Issues の番号を記載されているとレビュアーが非常に助かります 🙏

タイポなどの修正

手順は上記の 4. 以降と同じです。

翻訳スタイル

翻訳のゆらぎ & トーン

文体

「だである」ではなく「ですます」調

Vue.js is a library for building modern web interfaces.

  • NG : Vue.js はモダンな Web インターフェースを構築するためのライブラリーである。
  • OK : Vue.js はモダンな Web インターフェースを構築するためのライブラリーです。

半角スペースでアルファベット両端を入れて読みやすく！

Vue.js is a library for building modern web interfaces.

  • NG : Vue.jsはモダンなWebインターフェースを構築するためのライブラリーです。
  • OK : Vue.js はモダンな Web インターフェースを構築するためのライブラリーです。

例外として、句読点の前後にアルファベットがある場合は、スペースを入れなくてもいいです。

  • 読点: 技術的に、Vue.js は MVVM パターンの ViewModel レイヤーに注目しています。

原則、一語一句翻訳。ただし日本語として分かりにくい場合は読みやすさを優先

The keys of the object will be the list of classes to toggle based on corresponding values.

  • NG: オブジェクトのキーは、クラスのリストは対応する値に基づいてトグルします。
  • OK: オブジェクトのキーは、対応する値に基づいてトグルする class のリストになります。

原文に使われる ':' や '!' や '?' などの記号は極力残して翻訳

Example:

  • NG: 例
  • OK: 例:

ただし、文の途中にハイフン - やセミコロン ; があり、その記号があると理解しづらい訳になる場合は、例外として削除してもよいです。

  • 原文:

Avoid using track-by="$index" in two situations: when your repeated block contains form inputs that can cause the list to re-render; or when you are repeating a component with mutable state in addition to the repeated data being assigned to it.

  • 訳文:

track-by="$index" は2つの状況で使用を回避してください。繰り返されたブロックにリストを再描画するために使用することができる form の input を含んでいるとき、または、繰り返されるデータがそれに割り当てられる他に、可変な状態でコンポーネントを繰り返しているときです。

単語の統一（特に技術用語）

  • 技術用語は基本英語、ただ日本語で一般的に使われている場合は日本語 OK !!
    • 例: 英語の filter 、日本語のフィルター
  • 和訳に困った、とりあえず英語
    • 例: expression -> 式、表現
  • 和訳にして分かりづらい場合は、翻訳と英語（どちらかに括弧付け）でも OK
    • 例: Two way -> Two way（双方向）

詳細は 用字、用語 を参照してください。

長音訳について

原則、長音ありで翻訳する。

  • NG: コンピュータ
  • OK: コンピューター

注意事項

行の追加・削除をしない

行番号が変わってしまうと英語版ドキュメントの変更を取り込む際に対応箇所を探すのが難しくなるので、原文と同じ行に翻訳してください。

原文:

15 | Vue (pronounced /vjuː/, like **view**) is a ...
16 |
17 | Here is a minimal example:

NG: 空行がなくなっている

15 | Vue（**view**のように /vjuː/ と発音）は ...
16 | 以下は最小限の例です:

NG: 改行が増えている

15 | Vue（**view**のように /vjuː/ と発音）は ...
16 | これは標準的な HTML、CSS、JavaScript の ...
17 |
18 | 以下は最小限の例です:

OK: 行がそのまま

15 | Vue（**view**のように /vjuː/ と発音）は ...
16 |
17 | 以下は最小限の例です: