Skip to content

fix: AGENTS.md 自動生成セクションをリポジトリ実態から完全再生成 - #614

Merged
keito4 merged 1 commit into
mainfrom
fix/agents-md-auto-regeneration
Mar 22, 2026
Merged

fix: AGENTS.md 自動生成セクションをリポジトリ実態から完全再生成#614
keito4 merged 1 commit into
mainfrom
fix/agents-md-auto-regeneration

Conversation

@keito4

@keito4 keito4 commented Mar 22, 2026

Copy link
Copy Markdown
Owner

Summary

  • /repo-maintenance の Step 3.4.1 に基づき、AGENTS.md の自動生成セクションをリポジトリの現在の状態から完全に再生成
  • Nix 移行や .claude/rules/ 追加などの最近の変更が反映されていなかった問題を修正

変更内容

セクション 変更
Repository Overview macOS Environment (nix-darwin) を追加
Project Structure .claude/rules/, vscode/ を追加。ワークフロー数を明記
Available Commands /similarity-analysis の説明をフロントマターと一致
CI/CD Workflows container-security.yml の説明を詳細化 (Trivy, CodeQL, SBOM)
Quality Gates shellcheck コマンドを package.json の実際の値に更新
Development Standards 新セクション追加(TDD, Quality Gates, Git Workflow, release-types)

Test plan

  • 全テスト通過 (95 tests)
  • Prettier フォーマット通過

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation

  • Updated development environment setup guidance with macOS configuration details
  • Clarified CI/CD workflow descriptions and security scanning coverage
  • Enhanced repository structure documentation
  • Established explicit development standards including code quality requirements and Git workflow conventions

/repo-maintenance の Step 3.4.1 に基づき、AGENTS.md の自動生成セクションを
リポジトリの現在の状態から完全に再生成する。

追加:
- Repository Overview に macOS Environment (nix-darwin) を追記
- Project Structure に .claude/rules/, vscode/ を追加
- Development Standards セクション(release-types ルール等)

更新:
- shellcheck コマンドを package.json の実際の値に修正
- container-security.yml の説明を詳細化 (Trivy, CodeQL, SBOM)
- /similarity-analysis の説明をフロントマターと一致させる

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 22, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation-only updates to AGENTS.md that expand macOS development environment guidance, refine repository structure listings, tighten shellcheck command documentation, enhance CI workflow descriptions, and introduce explicit Development Standards section covering code quality and Git workflow conventions.

Changes

Cohort / File(s) Summary
Documentation Updates
AGENTS.md
Added macOS dev environment setup (nix-darwin + home-manager), updated repository structure listings (new .claude/rules/, adjusted directory counts and descriptions), refined /similarity-analysis command documentation, enhanced container-security.yml CI workflow description to specify Trivy, CodeQL, and SBOM coverage, tightened shellcheck command to restrict to script/ directory with exclusion patterns, and added new "Development Standards" section with code quality requirements (70%+ line coverage, static quality gates, Git conventions, semantic-release commit types).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested labels

docs

Poem

🐰 A rabbit hops through docs so bright,
With nix-flakes gleaming in the night,
Standards clear and workflows neat,
Development patterns now complete!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is in Japanese and describes regenerating AGENTS.md auto-generated sections from repository state, which directly matches the main change in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/agents-md-auto-regeneration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@keito4

keito4 commented Mar 22, 2026

Copy link
Copy Markdown
Owner Author

🔍 AI Code Review (Local Hook)

Models: Codex (default) / Gemini (default)

🤖 Codex Review

指摘事項はありません。変更はドキュメントの記述追加・更新のみで、正確性・パフォーマンス・セキュリティ・保守性・開発者体験に悪影響を与える差分は見当たりません。

総合判定: patch is correct(理由: 変更は AGENTS.md の情報追記・表記改善のみで、挙動や安全性に影響しないため) 信頼度: 0.78


🤖 Generated by post_pr_ai_review.py hook

@claude

claude Bot commented Mar 22, 2026

Copy link
Copy Markdown
Contributor

コードレビュー

概要

AGENTS.md のドキュメント同期 PR です。コードの変更はなく、リポジトリの実態とドキュメントの乖離を解消する内容です。全体的に正確で有益な更新です。


確認済み事項 ✅

変更内容 検証結果
.claude/rules/ ディレクトリ追加 実在確認済み(development-standards.md 等含む)
vscode/ ディレクトリ追加 実在確認済み(extensions.txt 等含む)
ワークフロー数 (15) 正確(templates/ はディレクトリのためカウント外)
shellcheck コマンド package.json の実際の値と完全一致を確認

指摘事項

Minor: Development Standards セクションの重複管理リスク

新規追加された ## Development Standards セクションは CLAUDE.md および .claude/CLAUDE.md と内容が重複しています。

現時点では内容が一致していますが、将来的に片方だけ更新されると乖離が生じます。

提案: AGENTS.md の該当セクションに参照先を示すコメントを追加するか、または自動生成スクリプトで両ファイルを同期する仕組みを検討してください。

例:

## Development Standards

> 詳細は [CLAUDE.md](./CLAUDE.md) を参照。
> 以下は CLAUDE.md から自動同期されたサマリです。

総評

ドキュメントの正確性向上は明確な価値があります。shellcheck コマンドの省略形(find script -name '*.sh' ... | xargs shellcheck -x)が実際のコマンド全体に修正されている点は特に良い改善です。

上記の Minor 指摘は必須修正ではありませんが、長期的なメンテナンス性のために検討を推奨します。

🤖 Reviewed with Claude Code

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Line 155: The sentence listing release-triggering commit types overstates docs
behavior; update the wording for the rule that mentions ".codex/**",
".devcontainer/codex*", "package*.json", and "npm/global.json" so it only treats
docs as release-triggering when the commit uses the README scope (e.g., change
"docs" to "docs (only when scope is README)" or equivalent clarification),
ensuring contributors won't assume any docs commit touching those tooling paths
will trigger a release.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f1c02243-2e3f-4fcd-9141-5f2b5b712a8c

📥 Commits

Reviewing files that changed from the base of the PR and between 4676651 and 77b1a15.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md
- **Test-Driven Development (TDD)**: Red -> Green -> Refactor methodology with 70%+ line coverage requirement
- **Static Quality Gates**: Automated linting, formatting, security analysis, and license checking
- **Git Workflow**: Conventional commits, branch naming conventions, and pull request requirements
- **Release Types Required for Tooling Changes**: Commits that touch `.codex/**`, `.devcontainer/codex*`, `package*.json`, or `npm/global.json` must use release-triggering types (`feat` / `fix` / `perf` / `revert` / `docs`). commitlint blocks `chore` etc. to align with semantic-release.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Release-type rule text overstates docs behavior

This line says docs is release-triggering for tooling changes, but current semantic-release rules only release docs when scope is README. This can mislead contributors into thinking any docs commit on tooling paths will release.

Suggested wording fix
-- **Release Types Required for Tooling Changes**: Commits that touch `.codex/**`, `.devcontainer/codex*`, `package*.json`, or `npm/global.json` must use release-triggering types (`feat` / `fix` / `perf` / `revert` / `docs`). commitlint blocks `chore` etc. to align with semantic-release.
+- **Release Types Required for Tooling Changes**: Commits that touch `.codex/**`, `.devcontainer/codex*`, `package*.json`, or `npm/global.json` must use release-triggering types (`feat` / `fix` / `perf` / `revert`). Note: `docs` triggers release only when scope is `README` per `.releaserc.json`.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Release Types Required for Tooling Changes**: Commits that touch `.codex/**`, `.devcontainer/codex*`, `package*.json`, or `npm/global.json` must use release-triggering types (`feat` / `fix` / `perf` / `revert` / `docs`). commitlint blocks `chore` etc. to align with semantic-release.
- **Release Types Required for Tooling Changes**: Commits that touch `.codex/**`, `.devcontainer/codex*`, `package*.json`, or `npm/global.json` must use release-triggering types (`feat` / `fix` / `perf` / `revert`). Note: `docs` triggers release only when scope is `README` per `.releaserc.json`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 155, The sentence listing release-triggering commit types
overstates docs behavior; update the wording for the rule that mentions
".codex/**", ".devcontainer/codex*", "package*.json", and "npm/global.json" so
it only treats docs as release-triggering when the commit uses the README scope
(e.g., change "docs" to "docs (only when scope is README)" or equivalent
clarification), ensuring contributors won't assume any docs commit touching
those tooling paths will trigger a release.

@keito4 keito4 self-assigned this Mar 22, 2026
@keito4
keito4 merged commit cb23df8 into main Mar 22, 2026
8 checks passed
@keito4
keito4 deleted the fix/agents-md-auto-regeneration branch March 22, 2026 14:26
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.105.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released リリース済み

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant