Skip to content

[BLIND] Codex対応のためAGENTS.mdを新規整備しSSOT重複を防止する #116

@LevelCapTech

Description

@LevelCapTech

依頼の要点

本リポジトリでは .github/copilot/ 配下を一次情報(SSOT)としてAIコーディング運用を行っている。
Codexにもレビューおよび実装を依頼するため、リポジトリルートに AGENTS.md を新規作成し、SSOTを重複させずにエージェント横断運用を成立させる。


背景・前提条件

利用者ロール

  • リポジトリ管理者
  • Copilot(GitHub統合エージェント)
  • Codex(AGENTS.mdを参照するエージェント)

実行環境

  • GitHubリポジトリ
  • CI品質ゲート有効(lint/typecheck/test/security)

外部依存

  • GitHub Copilot
  • OpenAI Codex GitHub連携

ネットワーク要件

  • GitHub上でAGENTS.mdが参照可能であること

セキュリティ前提

  • AGENTS.mdにSecretsや内部機密を記載しない
  • SSOTを複製しない(情報分岐事故防止)

スコープ定義

In Scope

  • ルートに AGENTS.md を新規作成
  • Codex向けレビュー・実装方針の最小記述
  • SSOT参照構造の明文化
  • SSOT重複禁止ルールの明示

Out of Scope

  • .github/copilot/ 内部仕様変更
  • CI設定変更
  • Copilot指示構造変更

境界条件

  • SSOTは .github/copilot/ に固定
  • AGENTS.mdに詳細規範を複製しない

仕様

ユースケース

主シナリオ

  1. CodexがPRをレビューする
  2. AGENTS.mdを読み込む
  3. レビュー形式・言語を決定する
  4. 詳細規範は .github/copilot/ を参照する
  5. 実装・修正を行う
  6. CIを通過させる

例外シナリオ

  • SSOTとAGENTS.mdに記述差異が発生した場合
    • .github/copilot/ を正とする
    • AGENTS.mdは参照リンクのみ修正する

AGENTS.md 内容(最終仕様)

# AGENTS.md

## Role
This repository uses `.github/copilot/` as the Single Source of Truth (SSOT).
Do not duplicate rules defined there.

## Implementation Guidelines
- Follow `.github/copilot-instructions.md`
- Follow `.github/instructions/**/*.instructions.md`
- Follow relevant files under `.github/copilot/10-60-*`
- CI must pass: lint / typecheck / test / security

## Review Guidelines
- レビューコメントは日本語で書くこと
- 形式は「重要度(P0/P1/P2) / 理由 / 修正案」
- SSOTと矛盾する提案は禁止

## Prohibitions
- SSOTの内容をAGENTS.mdに複製しない
- `.github/copilot/` の内容を変更する指示を勝手に出さない

## Conflict Resolution
If AGENTS.md and `.github/copilot/` conflict,
`.github/copilot/` takes precedence.

フロー可視化

flowchart TD
  A[Codex起動] --> B[AGENTS.md読込]
  B --> C[レビュー/実装方針決定]
  C --> D[.github/copilot/参照]
  D --> E[実装/レビュー実行]
  E --> F[CI実行]
  F --> G[品質ゲート確認]
Loading

非機能要件

可用性

  • SSOT分岐を起こさない

セキュリティ

  • Secrets記載禁止

運用性

  • SSOT変更時はAGENTS.mdはリンクのみ維持

拡張性

  • 将来エージェント追加時もAGENTS.mdは入口のみとする

受け入れ条件

  • AGENTS.mdがルートに存在する
  • SSOT内容が複製されていない
  • CIが緑
  • Codexが日本語レビューを行う

タスク分解

  • AGENTS.md新規作成
  • 上記内容を記載
  • CI確認
  • PR作成

リスク・影響範囲

リスク 原因 対策
SSOT分岐 二重記述 参照リンクのみ記載
更新漏れ 規範変更 SSOT優先ルール明示

未確定事項

  • Undetermined: Codexの将来仕様変更
    • 影響: レビュー形式変更の可能性
    • 決定方法: OpenAI公式ドキュメント確認

参考情報

  • .github/copilot/00-index.md
  • .github/copilot-instructions.md
  • .github/instructions/**/*.instructions.md

Metadata

Metadata

Assignees

Labels

💡 改善or提案プロジェクトの改善点や提案、一般的なフィードバックに使用します。

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions