コードレビューガイド(scripts / サイト基盤)
scripts/、doc/.vitepress/、.github/workflows/、generate-tag-pages.js 等を変更する際のレビュー基準。
対象パス
| パス | 内容 |
|---|---|
scripts/ | 検証・生成スクリプト |
doc/.vitepress/ | VitePress 設定・taxonomy |
generate-tag-pages.js | タグページ生成 |
.github/workflows/ | CI / エージェント WF |
package.json | ビルドスクリプト・依存 |
レビュー観点
変更最小化
- 依頼タスクに必要な範囲のみ変更
- 記事コンテンツ(
doc/blog/)への無関係な変更を含めない
既存パターンとの整合
- ESM(
import)形式を維持 - 既存スクリプト(
validate-content.js等)のログ形式・exit code パターンに合わせる - taxonomy は
doc/.vitepress/utils/taxonomy.jsが単一定義
検証
bash
node scripts/verify-agent-docs.js # 指示書変更時
npm run docs:build # 必須scripts のみ変更で doc/blog 未変更の場合、lint-prose はスキップ可。
ワークフロー変更時
- フォーク PR 除外など既存セキュリティ制約を維持
pathsフィルタ漏れがないか確認(WF 単独変更でも pr-check が走るか)- プロンプトに
AGENTS.md/doc/agent/参照を明示
禁止・注意
doc/tags/のindex.md以外を手編集しない(生成物)- 検証を恒久的に
--no-fail/skip-validationだけに依存しない - 一時ファイルは
temp/のみ(コミットしない)
チェックリスト
- [ ]
npm run docs:buildが exit 0 - [ ] 変更が task スコープ内
- [ ] 既存の validate / verify スクリプトとの整合
- [ ] WF 変更時は readme_workflow.md / doc/agent/workflows.md の更新要否を確認