fix: AGENTS.md 自動生成セクションをリポジトリ実態から完全再生成 - #614
Conversation
/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>
📝 WalkthroughWalkthroughDocumentation-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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
🔍 AI Code Review (Local Hook)Models: Codex (default) / Gemini (default) 🤖 Codex Review指摘事項はありません。変更はドキュメントの記述追加・更新のみで、正確性・パフォーマンス・セキュリティ・保守性・開発者体験に悪影響を与える差分は見当たりません。 総合判定: patch is correct(理由: 変更は 🤖 Generated by post_pr_ai_review.py hook |
コードレビュー概要AGENTS.md のドキュメント同期 PR です。コードの変更はなく、リポジトリの実態とドキュメントの乖離を解消する内容です。全体的に正確で有益な更新です。 確認済み事項 ✅
指摘事項Minor: Development Standards セクションの重複管理リスク新規追加された 現時点では内容が一致していますが、将来的に片方だけ更新されると乖離が生じます。 提案: 例: ## Development Standards
> 詳細は [CLAUDE.md](./CLAUDE.md) を参照。
> 以下は CLAUDE.md から自動同期されたサマリです。総評ドキュメントの正確性向上は明確な価値があります。shellcheck コマンドの省略形( 上記の Minor 指摘は必須修正ではありませんが、長期的なメンテナンス性のために検討を推奨します。 🤖 Reviewed with Claude Code |
There was a problem hiding this comment.
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.
| - **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. |
There was a problem hiding this comment.
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.
| - **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.
|
🎉 This PR is included in version 1.105.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Summary
/repo-maintenanceの Step 3.4.1 に基づき、AGENTS.md の自動生成セクションをリポジトリの現在の状態から完全に再生成.claude/rules/追加などの最近の変更が反映されていなかった問題を修正変更内容
macOS Environment(nix-darwin) を追加.claude/rules/,vscode/を追加。ワークフロー数を明記/similarity-analysisの説明をフロントマターと一致container-security.ymlの説明を詳細化 (Trivy, CodeQL, SBOM)shellcheckコマンドをpackage.jsonの実際の値に更新Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation