コントリビューションガイド

本ページはリポジトリルートにある正本 CONTRIBUTING.md のドキュメントサイト固有の補足です。プロジェクト全体の文脈（ステータス、ブランチ命名、コミットスタイル、PR プロセス、Definition of Done）は、まずルートの CONTRIBUTING.md を参照してください。

重要

すべてのパッケージは main にマージ済みで、外部からの pull request も受け付けています。設計フィードバックや RFC の議論については引き続き Issue を歓迎します。以下に示すワークフローは、現在運用中のコントリビュータ向けワークフローです。

main は GitHub branch protection で保護されています。内部・外部を問わず、すべての変更は pull request 経由で反映されます。direct push、force-push、branch 削除はすべてブロックされ、admin であっても bypass できません。required-approval count は 0 のため、メンテナは solo-dev の反復のために self-merge できますが、すべての変更は PR の記録を残します。詳細はルートの CONTRIBUTING.md §3 を参照してください。

どこから始めるか

  1. プロジェクトの README を読んで全体像を把握してください。

  2. ルートの CONTRIBUTING.md を読んでプロジェクト全体のワークフローを確認してください。

  3. ドキュメントサイト固有の作業は、本サイトの 開発環境セットアップ と ビルド に従ってください。

ドキュメントサイト固有のコントリビューション

sphinx-docs/ への代表的なコントリビューションは次のとおりです:

種類

変更対象

検証

翻訳の更新

sphinx-docs/locale/ja/LC_MESSAGES/<file>.po

make build-ja

英語のタイポや broken link を修正

sphinx-docs/**/*.md

make html、make linkcheck

新しい英語ページを追加

新規 .md + 親 index.md の toctree に追加

make update-po で .po を再生成し、翻訳

コードサンプルを改善

該当する .md

make html でレンダリングを検証

ソース .md を変更したら、make update-po を実行して新規文字列を日本語 .po ファイルに反映し、対応する msgstr を更新してください。

ブランチ命名とコミットスタイル

プロジェクトルートと同じです。CONTRIBUTING.md §3.1 / §3.2 を参照してください。ドキュメント変更では通常、docs/ ブランチプレフィックスと 📝 コミット絵文字を使います。

PR を開く前に

cd sphinx-docs
make lint          # ruff check + format
make build-all     # EN + JA + Pagefind assembly
make linkcheck     # broken-link detection (external 404s acceptable)

ビジュアルレイアウトが変わる場合は PR にスクリーンショットを添付してください。

翻訳ガイドライン

本プロジェクトの翻訳トーンは次のとおりです:

  • です・ます調（丁寧な日本語）。

  • 技術用語は 英語のまま とします（Layer 1 (Raw)、polymorphic variant、peerDependencies、IPC、Channel、Event、Window など）。

  • コードブロックは翻訳しません。msgid がコードを含む場合は、そのまま msgstr にコピーします。

  • URL とリンク先は翻訳しません。リンクのテキスト部分のみ翻訳します。

  • 共有用語の既存の訳語は、rescript-tauri 内部の docs/glossary.md と一致させてください。