docs: ADR運用文書を現行ルールへ合わせる - #99
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5daf3b437a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## 運用の 3 ルール | ||
| ADR の作成基準・書式・作成・更新・置換・廃止の手順は `adr` skill を正とする。 | ||
| このファイルには、このリポジトリの ADR 一覧と動かない結論だけを置く。 | ||
| 用語の定義は `CONTEXT.md` の責務とし、ADR には重複して書かない。 |
There was a problem hiding this comment.
CONTEXT.md に用語定義を委ねない
リポジトリ全体と当該コミットの追跡ファイルを検索しても CONTEXT.md は存在しません。この指示に従うと ADR から用語定義を省く一方で参照先にも定義がなくなり、将来の読者が判断時の語義を復元できません。CONTEXT.md を同じコミットで追加するか、実在する文書を指定する必要があります。
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
@codex 指摘どおり、参照先の CONTEXT.md が存在しないため該当行を削除しました。同じ誤りがあった4リポジトリすべてで修正し、相対リンク検証と git diff --check も再実行しています。
There was a problem hiding this comment.
解消です。現在の PR head c9606f7 を確認し、docs/adr/README.md から存在しない CONTEXT.md へ用語定義を委ねていた行が削除されていることを確認しました。追跡ファイル内に CONTEXT.md への参照は残っておらず、変更文書の相対リンク検証と git diff --check ca9163c..HEAD も成功しています。指摘した、定義を省略しながら参照先も存在しない状態は解消されています。
There was a problem hiding this comment.
判定
解消
現在の PR head c9606f7 では、存在しない CONTEXT.md に用語定義を委ねていた行が削除されています。ADR 運用の実在する参照先と、リポジトリ側に保持する内容のみが記載された状態です。 docs/adr/README.mdL5-L10
該当レビュー・スレッドへ判定根拠を返信しました。コード変更は行っていないため、新しいコミットおよびPRは作成していません。
Checks
- ✅
git show --format=fuller --no-ext-diff c9606f7b2a3c4f56e131fde6a37b5cb0c82c93bc -- docs/adr/README.md - ✅
git grep -n 'CONTEXT\.md'（追跡ファイル内に該当参照なし） - ✅
python - <<'PY' ... PY（変更文書の相対Markdownリンクがすべて実在） - ✅
git diff --check ca9163c0790b788ae53aadf7f15243306a81f9e0..HEAD - ✅
gh api graphql ... addPullRequestReviewThreadReply ...（判定コメントを投稿） ⚠️ gh api graphql ... resolveReviewThread ...（現在のGH_TOKENにスレッドをResolveする権限がなく、GitHubからResource not accessible by personal access tokenが返されたため、Resolveのみ未実施）- ✅
git status --short --branch（作業ツリーに変更なし）
There was a problem hiding this comment.
@codex 再確認した結果、前回の「参照を削除するだけ」の対応は過剰だったため、9534136 で補正しました。現在は、用語とコンテキスト境界の正を domain-modeling skill とし、CONTEXT.md は同 skill が必要時に作成・更新すると明記しています。未確定の用語がないため空の CONTEXT.md は追加せず、ADR への用語定義の重複も避けています。
There was a problem hiding this comment.
説明妥当です。現在の PR head 9534136 では、CONTEXT.md を常設の参照先として扱うのではなく、用語とコンテキスト境界の正を domain-modeling skill に置き、同文書は必要時に作成・更新する成果物だと明記されています。したがって、現時点で未確定の用語がないなら空の CONTEXT.md を追加する必要はなく、ADR 側へ同じ用語定義を重複させない方針とも整合します。元の指摘対象だった「存在しない文書へ既存定義を委ねる」状態ではないため、この説明は妥当と判断します。
There was a problem hiding this comment.
判定
説明妥当
現在の PR head 9534136 では、用語とコンテキスト境界の正を domain-modeling skill とし、CONTEXT.md は必要な場合に同 skill が作成・更新する成果物であることが明記されています。また、ADR に用語定義を重複させないという責務の分離も明確です。 docs/adr/README.mdL5-L10
したがって、現時点で未確定の用語がないなら、空の CONTEXT.md を追加する必要はありません。以前指摘した「存在しない文書に既存の用語定義を委ねる」状態とは異なるため、今回の説明は妥当と判断しました。
該当レビュー・スレッドへ判定根拠を返信しました。コード変更はないため、コミットおよび新規 PR の作成は行っていません。
Checks
- ✅
git rev-parse HEAD（PR head が95341363fc8013af918bf65ef932cbfe6eac43e8であることを確認） - ✅
git show --format=fuller --no-ext-diff 95341363fc8013af918bf65ef932cbfe6eac43e8 -- docs/adr/README.md AGENTS.md - ✅
gh issue view 98 --repo Ries630/StockCopilot --json title,body,url - ✅
git diff --check ca9163c0790b788ae53aadf7f15243306a81f9e0..HEAD - ✅
gh api graphql ... addPullRequestReviewThreadReply ...（判定コメントを投稿） - ✅
gh api --method PATCH repos/Ries630/StockCopilot/pulls/comments/3878651345 ...（投稿時にシェル展開されたコード表記を直ちに修正） ⚠️ gh api graphql ... resolveReviewThread ...（現在のGH_TOKENに Resolve 権限がなく、GitHub からResource not accessible by personal access tokenが返されたため、スレッドの Resolve のみ未実施）- ✅
git status --short --branch（作業ツリーに変更なし）
domain-modeling skill が用語とコンテキスト境界を担い、CONTEXT.md を必要時に作成・更新する責務を明確にする。
1 participant
概要
adrskill に一本化docs/adr/template.mdを現在の skill テンプレートへ同期AGENTS.mdとREADME.mdから置換手順の写経と現行手順の個人パス参照を削除検証
cmp -s docs/adr/template.md ~/.agents/skills/adr/assets/template.mdgit diff --checkuv run --with ruff ruff check .skills-ref==0.1.1による同封3スキルの検証uv run run_tests.py（369 passed）対象外
Closes #98