summaryrefslogtreecommitdiff
path: root/.github/instructions/documentation.instructions.md
diff options
context:
space:
mode:
authortanaka takashi <isazaka@gmail.com>2026-09-12 20:22:29 +0900
committertanaka takashi <isazaka@gmail.com>2026-09-12 20:22:29 +0900
commitcc6165947a82d2182df8accbc7b4adfe2606db9e (patch)
tree22d81e6986a32d54c0e6790d6a1cc89ab1b915e4 /.github/instructions/documentation.instructions.md
parentfd987cb31fd20483080f8d80ce35b53f101f243f (diff)
chore: GitHub Copilot向け開発指示と専用エージェントを追加
リポジトリ全体へ自動適用される.github/copilot-instructions.mdを追加し、仕様書と設計書を正本とする作業手順、変更範囲の確認、文書同期、利用者差分の保護、明示依頼なしのコミット禁止を定義する。 SD 1.x、Python 3.11、uv、CUDA 13.2、FP16、VAE必須、ローカルモデル、LoRA共通適用、固定ControlNet、単一GPUジョブ、限定サイズとschedulerなど、実装時に維持すべきシステム要件を常時コンテキストとして固定する。MCP公開面を小さく保ち、設定をTOMLへ集約する既存方針も明文化する。 server、tools、service、config、model_manager、pipeline_factoryの責務境界を定義し、設定やMCP schemaを変更する際に実装、validation、contract test、関連文書を一組として更新するよう指示する。 Python実装、pytest、文書と設定例に対するパス別instructionsを追加する。GPU不要テストの分離、設定enumと異常系、MCP非公開項目、pipeline constructor option、Service routingとエラーsanitizeなど、領域ごとの確認事項を固定する。 設計から実装、テスト、文書同期まで担当するsd15-maintainerカスタムエージェントを追加し、全ツール利用、手動選択、自動推論の両方を有効化する。Ruff format/check、Pyright、pytest、git diff/statusを完了ゲートとして必須化し、GPU smoke test未実施時は自動テストと区別して報告させる。 検証: ruff check、ruff format --check、pyright、pytest(39 passed)、git diff --checkを実行済み。data/配下は引き続きGit管理対象外。
Diffstat (limited to '.github/instructions/documentation.instructions.md')
-rw-r--r--.github/instructions/documentation.instructions.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/.github/instructions/documentation.instructions.md b/.github/instructions/documentation.instructions.md
new file mode 100644
index 0000000..9203f57
--- /dev/null
+++ b/.github/instructions/documentation.instructions.md
@@ -0,0 +1,15 @@
+---
+applyTo: "doc/**/*.md,README.md,config.example.toml"
+---
+
+# Documentation and configuration instructions
+
+- 文書と実装を一致させる。要件は`doc/Specifications.md`、責務と処理方式は`doc/Design.md`、
+ TOML仕様は`doc/config.md`、MCP公開契約は`doc/mcp.md`へ記載する。
+- 設定キー、既定値、enum、CLI、Tool schemaを変更した場合は、すべての表とコード例を検索して同期する。
+- `config.example.toml`はコピーして編集できる有効な例に保つ。ただし実モデル名、秘密情報、利用者固有の
+ 絶対パスを追加しない。
+- MCPに公開しない設定を`doc/mcp.md`のTool入力へ追加しない。
+- 推奨値とシステムが自動適用する値を混同しない。特にLCMのstep数とCFGは推奨例に留める。
+- 日本語で簡潔かつ具体的に書き、コード上の識別子、コマンド、設定値はバッククォートで囲む。
+- 実行確認していない機能を動作済みと記載しない。