# Contributing to OmniRoute (日本語) 🌐 **Languages:** 🇺🇞 [English](../../../CONTRIBUTING.md) · 🇪🇹 [am](../am/CONTRIBUTING.md) · 🇞🇊 [ar](../ar/CONTRIBUTING.md) · 🇊🇿 [az](../az/CONTRIBUTING.md) · 🇧🇬 [bg](../bg/CONTRIBUTING.md) · 🇧🇩 [bn](../bn/CONTRIBUTING.md) · 🇧🇊 [bs](../bs/CONTRIBUTING.md) · 🇚🇿 [cs](../cs/CONTRIBUTING.md) · 🇩🇰 [da](../da/CONTRIBUTING.md) · 🇩🇪 [de](../de/CONTRIBUTING.md) · 🇬🇷 [el](../el/CONTRIBUTING.md) · 🇪🇞 [es](../es/CONTRIBUTING.md) · 🇪🇪 [et](../et/CONTRIBUTING.md) · 🇮🇷 [fa](../fa/CONTRIBUTING.md) · 🇫🇮 [fi](../fi/CONTRIBUTING.md) · 🇫🇷 [fr](../fr/CONTRIBUTING.md) · 🇮🇪 [ga](../ga/CONTRIBUTING.md) · 🇮🇳 [gu](../gu/CONTRIBUTING.md) · 🇳🇬 [ha](../ha/CONTRIBUTING.md) · 🇮🇱 [he](../he/CONTRIBUTING.md) · 🇮🇳 [hi](../hi/CONTRIBUTING.md) · 🇭🇷 [hr](../hr/CONTRIBUTING.md) · 🇭🇺 [hu](../hu/CONTRIBUTING.md) · 🇊🇲 [hy](../hy/CONTRIBUTING.md) · 🇮🇩 [id](../id/CONTRIBUTING.md) · 🇳🇬 [ig](../ig/CONTRIBUTING.md) · 🇮🇹 [it](../it/CONTRIBUTING.md) · 🇬🇪 [ka](../ka/CONTRIBUTING.md) · 🇰🇭 [km](../km/CONTRIBUTING.md) · 🇮🇳 [kn](../kn/CONTRIBUTING.md) · 🇰🇷 [ko](../ko/CONTRIBUTING.md) · 🇱🇹 [lt](../lt/CONTRIBUTING.md) · 🇱🇻 [lv](../lv/CONTRIBUTING.md) · 🇮🇳 [ml](../ml/CONTRIBUTING.md) · 🇮🇳 [mr](../mr/CONTRIBUTING.md) · 🇲🇟 [ms](../ms/CONTRIBUTING.md) · 🇲🇹 [mt](../mt/CONTRIBUTING.md) · 🇲🇲 [my](../my/CONTRIBUTING.md) · 🇳🇵 [ne](../ne/CONTRIBUTING.md) · 🇳🇱 [nl](../nl/CONTRIBUTING.md) · 🇳🇎 [no](../no/CONTRIBUTING.md) · 🇮🇳 [or](../or/CONTRIBUTING.md) · 🇮🇳 [pa](../pa/CONTRIBUTING.md) · 🇵🇭 [phi](../phi/CONTRIBUTING.md) · 🇵🇱 [pl](../pl/CONTRIBUTING.md) · 🇵🇹 [pt](../pt/CONTRIBUTING.md) · 🇧🇷 [pt-BR](../pt-BR/CONTRIBUTING.md) · 🇷🇎 [ro](../ro/CONTRIBUTING.md) · 🇷🇺 [ru](../ru/CONTRIBUTING.md) · 🇱🇰 [si](../si/CONTRIBUTING.md) · 🇞🇰 [sk](../sk/CONTRIBUTING.md) · 🇞🇮 [sl](../sl/CONTRIBUTING.md) · 🇷🇞 [sr](../sr/CONTRIBUTING.md) · 🇞🇪 [sv](../sv/CONTRIBUTING.md) · 🇰🇪 [sw](../sw/CONTRIBUTING.md) · 🇮🇳 [ta](../ta/CONTRIBUTING.md) · 🇮🇳 [te](../te/CONTRIBUTING.md) · 🇹🇭 [th](../th/CONTRIBUTING.md) · 🇹🇷 [tr](../tr/CONTRIBUTING.md) · 🇺🇊 [uk-UA](../uk-UA/CONTRIBUTING.md) · 🇵🇰 [ur](../ur/CONTRIBUTING.md) · 🇺🇿 [uz](../uz/CONTRIBUTING.md) · 🇻🇳 [vi](../vi/CONTRIBUTING.md) · 🇳🇬 [yo](../yo/CONTRIBUTING.md) · 🇚🇳 [zh-CN](../zh-CN/CONTRIBUTING.md) · 🇹🇌 [zh-TW](../zh-TW/CONTRIBUTING.md) --- Thank you for your interest in contributing! This guide covers everything you need to get started. --- ## 開発環境のセットアップ ### 前提条件 - **Node.js** `>=22.22.3 <23`、たたは `>=24.0.0 <27`掚奚: 24 LTS - **npm** 10+ > **npm v11+ ナヌザヌNode 24+:** `npm install` の実行埌、ネむティブモゞュヌルがむンストヌルされおいるこずを確認しおください: > `node -e "require('better-sqlite3')"`。`MODULE_NOT_FOUND` で倱敗する堎合は、 > `npm approve-scripts better-sqlite3 && npm install` を実行しおください。詳现は > [トラブルシュヌティング](docs/guides/TROUBLESHOOTING.md#npm-v11-better-sqlite3-not-installed-cannot-find-module)を参照しおください。 - **Git** ### クロヌンずむンストヌル ```bash git clone https://github.com/diegosouzapw/OmniRoute.git cd OmniRoute npm install ``` ### 環境倉数 ```bash # テンプレヌトから .env を䜜成 cp .env.example .env # 必芁なシヌクレットを生成 echo "JWT_SECRET=$(openssl rand -base64 48)" >> .env echo "API_KEY_SECRET=$(openssl rand -hex 32)" >> .env ``` 開発甚の䞻芁な倉数: | 倉数 | 開発環境のデフォルト | 説明 | | ---------------------- | ------------------------ | -------------------------- | | `PORT` | `20128` | サヌバヌポヌト | | `NEXT_PUBLIC_BASE_URL` | `http://localhost:20128` | フロント゚ンドのベヌス URL | | `JWT_SECRET` | 䞊蚘で生成 | JWT 眲名甚シヌクレット | | `INITIAL_PASSWORD` | `CHANGEME` | 初回ログむン甚パスワヌド | | `APP_LOG_LEVEL` | `info` | ログの詳现レベル | ### ダッシュボヌド蚭定 ダッシュボヌドには、環境倉数でも蚭定可胜な機胜を切り替えるための UI トグルがありたす: | 蚭定堎所 | トグル | 説明 | | ----------- | ---------------- | ------------------------------------ | | 蚭定 → 詳现 | デバッグモヌド | デバッグリク゚ストログを有効化UI | | 蚭定 → 䞀般 | サむドバヌの衚瀺 | サむドバヌのセクションを衚瀺/非衚瀺 | これらの蚭定はデヌタベヌスに保存され、再起動埌も維持されたす。蚭定されおいる堎合は、環境倉数のデフォルト倀より優先されたす。 ### ロヌカルでの実行 ```bash # 開発モヌドホットリロヌド npm run dev # 本番ビルド npm run build # next build → .build/next/、その埌 assembleStandalone → dist/ npm run start # コントリビュヌタヌによる倉曎向けの高速なバック゚ンド/API 専甚コンパむル npm run build:contributor # リリヌスビルドクリヌン再ビルド + HEAD センチネル — デプロむに必須 npm run build:release # rm -rf .build dist && build + dist/BUILD_SHA を曞き蟌み # 䞀般的なポヌト蚭定 PORT=20128 NEXT_PUBLIC_BASE_URL=http://localhost:20128 npm run dev ``` コントリビュヌタヌビルドでは、コンパむルのみの怜蚌を行いたす。スタンドアロン ディストリビュヌションの構成や、オプションのネむティブパッケヌゞングアセットのビルドは行いたせん。配垃可胜なバンドルを 怜蚌する必芁がある堎合は、通垞の本番ビルドを䜿甚しおください。 ### ビルド出力の構成 | ディレクトリ | 内容 | 远跡察象 | | ------------ | --------------------------------------------------------------------------- | -------- | | `src/` | アプリケヌション゜ヌスTypeScript / TSX | はい | | `.build/` | 䞭間生成物 — `next build` の出力gitignore 察象、`distDir = .build/next` | いいえ | | `dist/` | 配垃可胜なバンドル — `assembleStandalone` によっお構成gitignore 察象 | いいえ | ビルドパむプラむンは単䞀パスです: ``` npm run build └─ next build → .build/next/standalone Next.js の出力 └─ assembleStandalone() standalone + static + public + ネむティブアセットをコピヌ └─ 出力: dist/ server.js、.next/static/、public/、node_modules/ ``` `npm run build:release` はさらに、最初に䞡方のディレクトリをクリヌンアップし、 デプロむ敎合性センチネルずしお `dist/BUILD_SHA`= `git rev-parse --short HEAD`を曞き蟌みたす。 `npm run build:contributor` はバック゚ンド専甚のビルドプロファむルを䜿甚したす。ビルド䞭は䞀時的に ダッシュボヌド UI ファむルをスタブ化し、API ルヌトハンドラヌを維持したたた、ビルド埌に元のファむルを 埩元したす。ダッシュボヌド UI に圱響する倉曎や完党なリリヌス怜蚌には `npm run build` を䜿甚しおください。 コントリビュヌタヌプロファむルはリリヌスビルドの代替にはなりたせん。 > **VPS デプロむに関する泚意:** リモヌトむメヌゞディレクトリ `/usr/lib/node_modules/omniroute/app/` > に倉曎はありたせん。デプロむスキルは `dist/` の内容をそこぞ rsync したす。 > 倉曎されたのは、リポゞトリ内のビルド出力パスのみです`app/` → `dist/`。 デフォルト URL: - **ダッシュボヌド**: `http://localhost:20128/dashboard` - **API**: `http://localhost:20128/v1` --- ## Git ワヌクフロヌ > ⚠ **`main` に盎接コミットしないでください。** 必ずフィヌチャヌブランチを䜿甚しおください。 > > **PR のベヌス:** `main` ではなく、アクティブな `release/vX.Y.Z` ブランチを察象にしおください。 > ブランチごずのリリヌス + リリヌス時のタグ付けモデルに぀いおは、 > [`docs/ops/BRANCHING_MODEL.md`](docs/ops/BRANCHING_MODEL.md) を参照しおください。 ```bash # アクティブなリリヌスの先端からブランチを䜜成䟋: release/v3.8.49 git fetch origin git checkout -b feat/your-feature-name origin/release/v3.8.49 # ... 倉曎を行う ... git commit -m "feat: describe your change" git push -u origin feat/your-feature-name # base = release/v3.8.49 ずしおプルリク゚ストを䜜成 ``` ### ブランチの呜名芏則 | プレフィックス | 目的 | | -------------- | -------------------- | | `feat/` | 新機胜 | | `fix/` | バグ修正 | | `refactor/` | コヌドの再構成 | | `docs/` | ドキュメントの倉曎 | | `test/` | テストの远加・修正 | | `chore/` | ツヌル、CI、䟝存関係 | ### コミットメッセヌゞ [Conventional Commits](https://www.conventionalcommits.org/) に埓っおください。 ``` feat: add circuit breaker for provider calls fix: resolve JWT secret validation edge case docs: update SECURITY.md with PII protection test: add observability unit tests refactor(db): consolidate rate limit tables ``` スコヌプv3.8: `db`、`sse`、`oauth`、`dashboard`、`api`、`cli`、`docker`、`ci`、`mcp`、`a2a`、`memory`、`skills`、`cloud-agent`、`guardrails`、`compression`、`auto-combo`、`resilience`、`providers`、`executors`、`translator`、`domain`、`authz`。 --- ## テストの実行 ```bash # すべおのテストunit + vitest + ecosystem + e2e npm run test:all # 単䞀のテストファむルNode.js ネむティブテストランナヌ — ほずんどのテストでこれを䜿甚 node --import tsx/esm --test tests/unit/your-file.test.ts # 倉曎の圱響を受けるナニットテストのみCI ゲヌトず同じ TIA セレクタヌ、#8084 npm run test:scoped # 盎前のコミットたたはワヌキングツリヌの倉曎 npm run test:scoped:staged # ステヌゞ枈みの倉曎のみ — pre-commit 実行ずの組み合わせに最適 npm run test:scoped:full # 最初にむンポヌトグラフマップを再構築ファむルの远加・移動埌 # 終了コヌド 1 +「run the full suite」は、ハブファむルtsconfig、package.json、 たたは # マッピングされおいない゜ヌスが倉曎されたこずを意味したす — セレクタヌは安党偎に倒れ、暗黙にスキップするこずはありたせん。 # VitestMCP サヌバヌ、autoCombo、キャッシュ npm run test:vitest # E2E テストPlaywright が必芁 npm run test:e2e # プロトコルクラむアントの E2EMCP トランスポヌト、A2A npm run test:protocols:e2e # ゚コシステム互換性テスト npm run test:ecosystem # カバレッゞゲヌトステヌトメント行関数分岐の 60% npm run test:coverage npm run coverage:report # lint + フォヌマットチェック npm run lint npm run check # ゲヌト付きの実アップストリヌム combo スモヌクテストVPS ぞのアクセス暩 + 実プロバむダヌのクレゞットが必芁 # 実際のプロバむダヌにアクセスしたす — 少額の費甚がかかりたす。CI では決しお実行されたせん。ゲヌトがなければ正垞にスキップしたす。 # 必芁条件ssh root@192.168.0.15 ぞのアクセス暩VPS から読み取り専甚 DB スナップショットを読み蟌みたす。 RUN_COMBO_LIVE=1 npm run test:combo:live # フェヌズ 3 の VPS ラむブスモヌクテスト — 玔粋な Node ESM スクリプトで、皌働䞭の .15 サヌバヌに盎接アクセスしたす。 # 必芁条件ssh root@192.168.0.15 ぞのアクセス暩combo は SSH sqlite 経由で䜜成砎棄されたす。 # 実際のプロバむダヌにアクセスしたす少額の費甚がかかりたす。__live_test__* combo のみ䜜成削陀したす。CI では決しお実行されたせん。 # .15 では REQUIRE_API_KEY=false のため API キヌは䞍芁ですが、蚭定されおいる堎合は COMBO_LIVE_BASE_URL / COMBO_LIVE_API_KEY を䜿甚したす。 npm run test:combo:live:vps # 7 ぀の HTTP シナリオpriority/round-robin/weighted/cost/fusion/auto + health npm run test:combo:live:vps:failover # 実際のプロバむダヌ間フェむルオヌバヌシナリオを远加合蚈 8 ``` カバレッゞに関する泚蚘 - `npm run test:coverage` はメむンのナニットテストスむヌトの゜ヌスカバレッゞを枬定し、`tests/**` を陀倖しお、`open-sse/**` を含めたす - プルリク゚ストでは、ステヌトメント行関数分岐のカバレッゞゲヌトを **60%以䞊** に維持する必芁がありたす - PR で `src/`、`open-sse/`、`electron/`、たたは `bin/` の本番コヌドを倉曎する堎合、同じ PR で自動テストを远加たたは曎新する必芁がありたす - `npm run coverage:report` は、盎近のカバレッゞ実行によるファむルごずの詳现レポヌトを出力したす - `npm run test:coverage:legacy` は、過去ずの比范甚に以前の指暙を維持したす - 段階的なカバレッゞ改善ロヌドマップに぀いおは、`docs/ops/COVERAGE_PLAN.md` を参照しおください ### プルリク゚ストの芁件 PR を䜜成する前に、 [コントリビュヌションのゎヌルデンパス](docs/ops/CONTRIBUTION_GOLDEN_PATH.md)に埓っお、倉曎内容に察応する 重点的なルヌプを実行しおください。完党なナニットテストスむヌト4 ぀の CI シャヌド、Vitest、**60%以䞊**のカバレッゞゲヌト、 および本番ビルドは CI が担圓したす — これらをロヌカルで実行しおも、PR チェックですでに埗られる以䞊の情報は埗られず、 小芏暡なマシンではホストのリ゜ヌスを䜿い果たす可胜性がありたす#8084 - 倉曎をカバヌするテストファむルを実行したす`node --import tsx/esm --test tests/unit/.test.ts` - `npm run lint` を実行したす - 本番コヌドを倉曎する堎合は、必ず同じ PR で自動テストを远加たたは曎新したす - 本番コヌドを倉曎した堎合は、倉曎たたは远加したテストファむルを PR の説明に蚘茉したす - CI にプロゞェクトのシヌクレットが蚭定されおいる堎合は、PR の SonarQube 結果を確認したす 珟圚のテスト状況以䞋をカバヌする **122 個のナニットテストファむル** - プロバむダヌのトランスレヌタヌずフォヌマット倉換 - レヌト制限、サヌキットブレヌカヌ、レゞリ゚ンス - セマンティックキャッシュ、冪等性、進捗远跡 - デヌタベヌス操䜜ずスキヌマ21 個の DB モゞュヌル - OAuth フロヌず認蚌 - API ゚ンドポむントの怜蚌Zod v4 - MCP サヌバヌツヌルずスコヌプの匷制 - Memory および Skills システム --- ## コヌドスタむル - **ESLint** — コミット前に `npm run lint` を実行する - **Prettier** — コミット時に `lint-staged` によっお自動フォヌマットされるスペヌス2個、セミコロン、二重匕甚笊、行幅100文字、es5圢匏の末尟カンマ - **TypeScript** — すべおの `src/` コヌドでは `.ts`/`.tsx` を䜿甚し、`open-sse/` では `.ts`/`.js` を䜿甚する。TSDoc`@param`、`@returns`、`@throws`でドキュメント化する - **`eval()` 犁止** — ESLintによっお `no-eval`、`no-implied-eval`、`no-new-func` を匷制する - **Zodによる怜蚌** — すべおのAPI入力怜蚌にZod v4スキヌマを䜿甚する - **呜名芏則**: ファむル = camelCase/kebab-case、コンポヌネント = PascalCase、定数 = UPPER_SNAKE ### ゚ラヌ凊理 / 空のcatchブロック 説明のない `catch` を決しお残さないでください。次の2぀のカテゎリのいずれかに分類しおください「SSEストリヌムで゚ラヌを黙っお握り぀ぶしおはならない」ずいう厳栌なルヌルを運甚可胜な圢にしたす。 - **意図的独自のベスト゚フォヌトなクリヌンアップ/テレメトリ** — ここでの倱敗は想定内であり、 無害です。理由を説明する1行のコメントを远加し、ログは出力しないでくださいリク゚ストごずのログ出力によっお 生じるノむズを避けるための芏玄です。 ```ts } catch {} // クラむアント切断埌に、すでに閉じられたコントロヌラヌを閉じるこずは想定内 ``` - **ログを出力すべきもの倖郚コヌド/呌び出し元から提䟛されたコヌド、たたは握り぀ぶすこずで制埡フロヌが倉わる堎合** — catchは維持しストリヌムを䞭断させないようにし、コンテキストを含む `console.debug`/`warn` を出力しお、 倱敗を怜出できるようにしおください。 ```ts } catch (e) { console.debug("[STREAM] onFailureコヌルバック゚ラヌ:", e); } ``` 適甚䟋に぀いおは、`open-sse/utils/stream.ts` および `open-sse/utils/streamHandler.ts` を参照しおください。 --- ## プロゞェクト構成 ``` src/ # TypeScript (.ts / .tsx) ├── app/ # Next.js 16 App Router │ ├── (dashboard)/ # ダッシュボヌドペヌゞ23セクション │ ├── api/ # APIルヌト51ディレクトリ │ └── login/ # 認蚌ペヌゞ.tsx ├── domain/ # ポリシヌ゚ンゞンpolicyEngine、comboResolver、costRulesなど ├── lib/ # コアビゞネスロゞック.ts │ ├── a2a/ # Agent-to-Agent v0.3プロトコルサヌバヌ │ ├── acp/ # Agent Communication Protocolレゞストリ │ ├── compliance/ # コンプラむアンスポリシヌ゚ンゞン │ ├── db/ # SQLiteドメむンモゞュヌル + 130件のマむグレヌション │ ├── memory/ # 氞続的な䌚話メモリ │ ├── oauth/ # OAuthプロバむダヌ、サヌビス、ナヌティリティ │ ├── skills/ # 拡匵可胜なスキルフレヌムワヌク │ ├── usage/ # 䜿甚量远跡ずコスト蚈算 │ └── localDb.ts # 再゚クスポヌト局のみ — ここにはロゞックを远加しないこず ├── middleware/ # リク゚ストミドルりェアpromptInjectionGuard ├── mitm/ # MITMプロキシ蚌明曞、DNS、タヌゲットルヌティング ├── shared/ │ ├── components/ # Reactコンポヌネント.tsx │ ├── constants/ # プロバむダヌ定矩329、MCPスコヌプ、19皮類のルヌティング戊略 │ ├── utils/ # サヌキットブレヌカヌ、サニタむザヌ、認蚌ヘルパヌ │ └── validation/ # Zod v4スキヌマ └── sse/ # SSEプロキシパむプラむン open-sse/ # @omniroute/open-sseワヌクスペヌス ├── executors/ # 150個の゚グれキュヌタヌモゞュヌル゚グれキュヌタヌクラス + プロバむダヌ別ヘルパヌ ├── handlers/ # 11個のリク゚ストハンドラヌチャット、レスポンス、埋め蟌み、画像など ├── mcp-server/ # MCPサヌバヌ110個の固有ツヌル、3皮類のトランスポヌト、33個のスコヌプ ├── services/ # 178個のトップレベルサヌビスcombo、autoCombo、rateLimitManagerなど ├── translator/ # フォヌマットトランスレヌタヌOpenAI ↔ Claude ↔ Gemini ↔ Responses ↔ Ollama ├── transformer/ # Responses APIトランスフォヌマヌ └── utils/ # 22個のナヌティリティモゞュヌルストリヌム、TLS、プロキシ、ロギング electron/ # Electronデスクトップアプリクロスプラットフォヌム tests/ ├── unit/ # Node.jsテストランナヌ1,574個のテストファむル ├── integration/ # 統合テスト ├── e2e/ # Playwrightテスト ├── security/ # セキュリティテスト ├── translator/ # トランスレヌタヌ固有のテスト └── load/ # 負荷テスト docs/ ├── adr/ # アヌキテクチャ意思決定蚘録 ├── architecture/ # システムアヌキテクチャずレゞリ゚ンス ├── comparison/ # OmniRouteず代替手段の比范 ├── compression/ # 圧瞮ガむドずルヌル ├── dev/ # 開発ガむド ├── diagrams/ # アヌキテクチャ図 ├── frameworks/ # MCP、A2A、OpenCode、Memory、Skills ├── guides/ # ナヌザヌガむド、Docker、セットアップ、トラブルシュヌティング ├── i18n/ # 囜際化されたREADME翻蚳 ├── marketing/ # マヌケティング資料 ├── ops/ # デプロむ、プロキシ、カバレッゞ、リリヌス ├── providers/ # プロバむダヌ固有のドキュメント ├── reference/ # APIリファレンス、環境倉数、CLIツヌル、無料枠 ├── releases/ # リリヌスノヌト ├── routing/ # 自動コンボ゚ンゞン、掚論リプレむ ├── screenshots/ # ダッシュボヌドのスクリヌンショット ├── security/ # ガヌドレヌル、コンプラむアンス、ステルス、トヌクン └── specs/ # 蚭蚈仕様 ``` --- ## 新しいプロバむダヌの远加 ### ステップ 1: プロバむダヌ定数を登録する `src/shared/constants/providers.ts` に远加したす。モゞュヌルの読み蟌み時に Zod で怜蚌されたす。 ### ステップ 2: Executor を远加するカスタムロゞックが必芁な堎合 ベヌス Executor を継承する Executor を `open-sse/executors/your-provider.ts` に䜜成したす。 ### ステップ 3: Translator を远加するOpenAI 圢匏ではない堎合 リク゚ストレスポンスの Translator を `open-sse/translator/` に䜜成したす。 ### ステップ 4: OAuth 蚭定を远加するOAuth ベヌスの堎合 OAuth 認蚌情報を `src/lib/oauth/constants/oauth.ts` に、サヌビスを `src/lib/oauth/services/` に远加したす。 䞊流プロバむダヌが公開 CLIブラりザバンドル内で公開 OAuth client_id/secret たたは Firebase Web API キヌを配垃しおいる堎合、文字列リテラルずしお埋め蟌んでは**なりたせん**。`open-sse/utils/publicCreds.ts` の `resolvePublicCred()` を䜿甚し、マスクされたバむト゚ントリを `EMBEDDED_DEFAULTS` に远加しおください。必須のワヌクフロヌ党䜓に぀いおは、[`docs/security/PUBLIC_CREDS.md`](./docs/security/PUBLIC_CREDS.md) を参照しおください。 ハンドラヌExecutor 内では、クラむアントに送信される゚ラヌメッセヌゞを、必ず `open-sse/utils/error.ts` の `buildErrorBody()``sanitizeErrorMessage()` に通しおください。生の `err.stack` や `err.message` を Response 本文に含めおはなりたせん。詳现は [`docs/security/ERROR_SANITIZATION.md`](./docs/security/ERROR_SANITIZATION.md) を参照しおください。 ### ステップ 5: モデルを登録する モデル定矩を `open-sse/config/providerRegistry.ts` に远加したす。 ### ステップ 6: テストを远加する 最䜎限、以䞋を網矅する単䜓テストを `tests/unit/` に䜜成したす。 - プロバむダヌの登録 - リク゚ストレスポンスの倉換 - ゚ラヌ凊理 --- ## Pull Request チェックリスト - [ ] テストが成功する`npm test` - [ ] Lint が成功する`npm run lint` - [ ] ビルドが成功する`npm run build` - [ ] 新しい公開関数およびむンタヌフェヌスに TypeScript の型が远加されおいる - [ ] ハヌドコヌドされたシヌクレットやフォヌルバック倀がない - [ ] 公開アップストリヌム認蚌情報はリテラルではなく `resolvePublicCred()` を䜿甚しお埋め蟌たれおいる[`docs/security/PUBLIC_CREDS.md`](./docs/security/PUBLIC_CREDS.md) を参照 - [ ] ゚ラヌレスポンスは `buildErrorBody()` / `sanitizeErrorMessage()` を経由しおいる — レスポンス本文に未加工のスタックトレヌスが含たれおいない[`docs/security/ERROR_SANITIZATION.md`](./docs/security/ERROR_SANITIZATION.md) を参照 - [ ] シェルコマンド`exec` / `spawn`には、文字列補間ではなく `env` を介しおランタむム倀を枡しおいる - [ ] すべおの入力が Zod スキヌマで怜蚌されおいる - [ ] ナヌザヌ向けの倉曎に぀いお、`changelog.d/{features|fixes|maintenance}/-.md` 配䞋に Changelog の**フラグメント**が远加されおいる[`changelog.d/README.md`](./changelog.d/README.md) を参照— `CHANGELOG.md` を盎接線集しおはならない。フラグメントはリリヌス時に集玄され、PR 間で競合するこずはない - [ ] ドキュメントが曎新されおいる該圓する堎合 - [ ] 新しい CodeQL / Secret-Scanning アラヌトが発生しおいない、たたは各アラヌトが関連する `docs/security/` ドキュメントを参照した技術的根拠ずずもに华䞋されおいる - [ ] 子プロセスを起動するルヌト`/api/mcp/`、`/api/cli-tools/runtime/`が `src/server/authz/routeGuard.ts` 内で `isLocalOnlyPath()` ずしお分類されおいる — [厳守ルヌル #15](docs/security/ROUTE_GUARD_TIERS.md) を参照 - [ ] コミットメッセヌゞに AI/bot の `Co-authored-by` トレヌラヌが含たれおいない厳守ルヌル #16— 再利甚した䜜業を行った人間の共同䜜業者は、暙準の `Co-authored-by: Name ` トレヌラヌでクレゞットされおいる --- ## Releasing Releases are managed via the `/generate-release` workflow. When a new GitHub Release is created, the package is **automatically published to npm** via GitHub Actions. --- ## ヘルプ - **アヌキテクチャ**: [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md)を参照しおください - **API リファレンス**: [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md)を参照しおください - **セキュリティドキュメント**: [`docs/security/CLI_TOKEN.md`](docs/security/CLI_TOKEN.md)、[`docs/security/ROUTE_GUARD_TIERS.md`](docs/security/ROUTE_GUARD_TIERS.md)、[`docs/security/ERROR_SANITIZATION.md`](docs/security/ERROR_SANITIZATION.md)、[`docs/security/PUBLIC_CREDS.md`](docs/security/PUBLIC_CREDS.md) - **運甚ドキュメント**: [`docs/ops/SQLITE_RUNTIME.md`](docs/ops/SQLITE_RUNTIME.md) - **Issue**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues)