1.8 KiB
1.8 KiB
GitHub Copilot Instructions
位置づけ
- 共通ルールの正本は、リポジトリルートの
AGENTS.mdとする。 - このファイルには、共通ルールを長文で再掲しない。
- Python、DB、FastAPI、Streamlit、Worker、Logging、テスト、フォルダ構成などの基本方針は
AGENTS.mdに従う。 - 技術領域ごとの詳細指示がある場合は、対象ファイルに応じて専用の指示ファイルも参照する。
- DDL作成、Worker分離、Streamlitページ改修など、特定作業の詳細手順が必要な場合は
.agents/skills/配下のSKILL.mdを参照する。 - このファイルと
AGENTS.mdの内容が矛盾する場合は、AGENTS.mdを優先する。
作業方針
- 変更前に、既存コード、既存ドキュメント、既存の命名規則、既存のディレクトリ構成を確認する。
- 大きな変更は、小さな単位に分けて提案・実装する。
- 既存の設計を無視して、新しい構成や新しい仕組みを勝手に作らない。
- 既存の類似実装がある場合は、その配置、命名、責務分離に合わせる。
- 変更によりロジックが変わる場合は、テストの追加・修正を検討する。
- 変更後の確認コマンドは、
AGENTS.mdの「品質チェック / テスト」に従う。
GitHub Copilot 向け補足
- GitHub Copilot は、まず
AGENTS.mdの共通方針に従う。 - ファイル種別・技術領域ごとの詳細指示がある場合は、
.github/instructions/配下の*.instructions.mdを参照する。 - このファイルには、Copilot固有の運用方針だけを書く。
- Cursor向けの
.cursor/rules/project.mdcと、補足内容が大きくズレないようにする。