docs: update README with recent additions

[keito4]

Summary

Update main README.md to reflect recent additions from issues #227-#224.

Changes

• 📝 Add .github/ directory description with workflow templates
• 📝 Update .codex/ description to include DevContainer recommendations
• 📝 Add check-docs-sync.sh to script/ description
• 📝 Add reference to script/README.md

Documentation Updates

.github/ Directory

Added description for GitHub configuration directory:

• Workflows for CI/CD, security scanning, and release automation
• Templates subdirectory with reusable workflow templates
• Unified CI with coverage reporting
• Monorepo releases with change detection

.codex/ Directory

Enhanced description to include:

• DevContainer recommendations
• Feature documentation

script/ Directory

Added check-docs-sync.sh to the list of utility scripts and referenced the comprehensive script/README.md.

Context

These updates document the additions made in:

• PR feat: add commitlint config with Japanese language support #230: commitlint config with Japanese language support
• PR feat: add common-utils with Zsh to DevContainer recommendations #231: common-utils with Zsh feature
• PR feat: enhance Docker-in-Docker documentation with best practices #232: Docker-in-Docker documentation
• PR feat: add documentation sync checker script #233: documentation sync checker
• PR feat: add unified CI and monorepo release workflow templates #234: unified CI and monorepo release workflows

Fixes #221

🤖 Generated with Claude Code

[coderabbitai]

Warning

Rate limit exceeded

@keito4 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 19 minutes and 29 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 11be2f2 and a43865a.

📒 Files selected for processing (1)

• README.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[claude]

コードレビュー結果

PR #235のドキュメント更新をレビューしました。以下のフィードバックを提供します。

✅ 良い点

1. 明確な目的: README.mdに最近の追加機能を反映するという明確な目的がある
2. 適切なコミットメッセージ: Conventional Commits形式に準拠し、docs:プレフィックスを使用
3. 関連Issueの参照: Fixes #221として適切にIssueをリンク
4. 変更範囲が適切: 3行追加、2行削除と最小限の変更

⚠️ 問題点・改善提案

1. 参照の不整合 (重要)

README.mdで以下のファイル/ディレクトリを参照していますが、実際には存在しません:

• .github/templates/: README.mdで「The templates/ subdirectory contains reusable workflow templates」と記載されていますが、.github/配下にtemplates/ディレクトリが存在しません
• script/README.md: 「See script/README.md for details」とリンクがありますが、このファイルが存在しません
• script/check-docs-sync.sh: README.mdで言及されていますが、script/配下にこのファイルが存在しません

推奨対応:

• 存在しないファイル/ディレクトリへの参照を削除するか、実際にファイルを作成する
• もし PR feat: add documentation sync checker script #233 で追加される予定なら、PRの説明にその旨を明記する

2. ドキュメント品質

.github/の説明が追加されたのは良いですが、より具体的な情報があると有用です:

現在:

GitHub configuration including workflows for CI/CD, security scanning, and release automation. The templates/ subdirectory contains reusable workflow templates...

改善案:
実際に存在するワークフローファイルに基づいた説明:

• ci.yml: Unified CI with linting, testing, and coverage reporting
• docker-image.yml: DevContainer image builds with semantic versioning
• claude.yml / claude-code-review.yml: AI-assisted code review
• security.yml / container-security.yml: Security scanning
• update-libraries.yml: Automated dependency updates

3. テストカバレッジ

CLAUDE.mdで定義されている70%+行カバレッジ要件に対して、このPRではテストが不要ですが、ドキュメントの正確性を検証する自動化テストがあると理想的です。

例: script/check-docs-sync.shのようなスクリプトで、README.mdで参照されているファイルが実際に存在するかチェック

📋 Definition of Done チェック

CLAUDE.mdの基準に基づく確認:

• ✅ Acceptance Criteria明文化: PR説明で明確
• ✅ Quality Gate Pass: ドキュメント変更のため該当なし
• ⚠️ ドキュメント更新: README.md自体の更新だが、参照の不整合あり
• ❓ リリースノート: 問題修正後に作成

🔧 推奨アクション

1. 即座に対応すべき事項:

   • 存在しないファイル/ディレクトリへの参照を削除または修正
   • .github/templates/への言及を削除
   • script/README.mdへのリンクを削除するか、ファイルを作成
   • check-docs-sync.shへの言及を削除するか、ファイルを作成

2. 将来的な改善:

   • ドキュメント参照の整合性をチェックする自動化スクリプトの追加
   • 実際のワークフローファイルに基づいた、より詳細な.github/の説明

総合評価

ドキュメント更新の意図は良いですが、存在しないファイルへの参照が含まれているため、修正が必要です。これらを修正した後であればマージ可能です。

---

🤖 Generated by Claude Code Review

[github-actions]

🎉 This PR is included in version 1.30.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀