ドキュメント翻訳ガイドライン
Fish ドキュメントをあらゆる言語に翻訳するためのコミュニティ貢献を心から歓迎します。このガイドでは、翻訳ワークフロー、開示ポリシー、緩和されたコントリビューター規則、およびベストプラクティスについて説明します。
適用範囲
翻訳はドキュメント（docs/ 以下の Markdown ファイルおよびプロジェクトガイド）のみに適用されます。
- ソースコード、テスト、識別子、Git コミットメッセージは 100% 英語である必要があります。
- ドキュメント内の CLI コマンド、フラグ名、コードスニペット、設定キーは翻訳しないでください。
ドキュメント貢献者向けの緩和規則
誰でも気軽に参加できるよう、ドキュメントに関しては以下の柔軟なポリシーを採用しています：
段階的・部分的な翻訳を歓迎:
- 一度にドキュメント全体を翻訳する必要はありません。
- 単一のセクション（インストール や クイックスタート など）のみの翻訳でも大歓迎です。
- 未完了のセクションは英語の原文を残すか、
<!-- TODO: translate this section -->のようなコメントを残してください。
ローカルの Rust 環境構築は不要:
- ドキュメント貢献のためにリポジトリのクローンや Rust のローカルインストールは必須ではありません。
- GitHub Web UI の鉛筆アイコンをクリックして、ブラウザから直接編集できます。
ファストトラックレビュー:
- 誤字修正、フォーマット改善、リンク更新、翻訳の推敲に関する PR は優先的にレビューされ、迅速にマージされます。
サポート言語
すべての言語での翻訳を受け付けています。Fish では以下の 5 つのコア言語を優先的にメンテナンスしています：
| 言語 | 言語コード | 状態 | 役割 |
|---|---|---|---|
| 英語 (English) | en | アクティブ | 公式標準ソース |
| 簡体字中国語 (简体中文) | zh-CN | オープン | コアコミュニティ言語 |
| 繁体字中国語 (繁體中文) | zh-TW | オープン | コアコミュニティ言語 |
| 日本語 (日本語) | ja | オープン | コアコミュニティ言語 |
| ベトナム語 (Tiếng Việt) | vi | オープン | コアコミュニティ言語 |
| その他のすべての言語 (スペイン語、フランス語、ドイツ語、韓国語など) | * | オープン | コミュニティ拡張言語 |
ツールポリシーと機械翻訳の開示義務
1. 自動翻訳・AIツールの利用許可
コントリビューターは、AI アシスタント (ChatGPT, Claude, Gemini) や機械翻訳エンジン (DeepL, Google 翻訳) を下書きや効率化のために利用できます。
2. 機械翻訳の開示義務
透明性を保つため、翻訳 PR を作成する際は、自動ツールの使用有無を PR の説明文に必ず開示してください。
PR 内で該当するレベルを選択してください：
- Tier 1 - 完全人間手動翻訳: ネイティブまたは流暢な話者による 100% 人手翻訳。
- Tier 2 - AI/機械翻訳 + ネイティブ校正: 初稿を機械/AI で作成し、ネイティブ話者が徹底的に校正・修正。
- Tier 3 - AI/機械翻訳下書き (要校正): 機械/AI で生成されたままの状態。
3. ネイティブ話者レビューの優先マージ
自然な表現と専門用語の正確性を担保するため、ネイティブ話者が関与した翻訳を優先してマージします。
ディレクトリ構成
翻訳は docs/ 配下の ISO 言語コードディレクトリに配置されます：
text
docs/
├── getting-started.md # 英語 (標準ソース)
├── architecture.md # 英語 (標準ソース)
├── vi/ # ベトナム語
│ ├── getting-started.md
│ └── architecture.md
├── zh-CN/ # 簡体字中国語
│ ├── getting-started.md
│ └── architecture.md
├── zh-TW/ # 繁体字中国語
│ ├── getting-started.md
│ └── architecture.md
├── ja/ # 日本語
│ ├── getting-started.md
│ └── architecture.md
└── <lang-code>/ # その他の言語 (例: es, fr, de, ko)
└── getting-started.md翻訳の提出方法
方法 A: GitHub Web インターフェイスから（最も簡単）
- GitHub 上で
docs/配下の対象ファイルを開きます。 - 右上の Edit this file（鉛筆アイコン）をクリックします。
- 新しいブランチに変更を保存し、Pull Request を作成します。
方法 B: Git コマンドラインから
- リポジトリをフォークしてクローンします:bash
git clone https://github.com/<your-username>/fish.git cd fish git checkout -b docs/translate-<lang>-<topic> docs/<lang-code>/配下の Markdown ファイルを作成または編集します。- 英語のコミットメッセージでコミットします (例:
docs: translate getting-started to Japanese)。 - フォーク先にプッシュし、
devブランチに向けて Pull Request を開きます。
方法 C: 自動翻訳ツール (Google Translate) から
組み込みの Markdown 構文保護自動翻訳スクリプトを実行し、4 言語 (vi, zh-hans, zh-hant, ja) へ自動同期・翻訳します:
bash
npm run docs:translate
# またはドキュメントの同期状態をチェック:
npm run docs:translate:check