feat: add common-utils with Zsh to DevContainer recommendations

[keito4]

Summary

Add comprehensive documentation for the common-utils DevContainer feature with Zsh configuration to the DevContainer recommendations.

Changes

• ✨ Add common-utils with Zsh section to .codex/devcontainer-recommendations.md
• 📝 Document benefits, considerations, and usage scenarios
• 📝 Provide alternative configuration for Bash users
• 📝 Include recommended environment variables for Zsh setup

Key Features Documented

Common-utils with Zsh

The documentation covers:

• Feature Configuration: How to enable Zsh as default shell
• Benefits: Smart tab completion, plugin ecosystem, customizable prompts
• Considerations: Learning curve, compatibility with Bash scripts
• Alternative: How to use common-utils without Zsh
• Environment Variables: Recommended SHELL configuration

Configuration Example

{
  "ghcr.io/devcontainers/features/common-utils:2": {
    "configureZshAsDefaultShell": true
  }
}

Recommended Use Cases

• Projects prioritizing developer productivity
• Terminal-heavy workflows
• Teams wanting unified shell environments

Benefits

• 🚀 Improves developer experience with modern shell features
• 📚 Provides clear guidance for both Zsh and Bash users
• ✅ Includes practical examples and configuration
• 🎯 Helps teams make informed decisions about shell choice

Fixes #226

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added documentation for a new optional Zsh configuration feature in development containers, including setup details with Oh-My-Zsh, CLI tools, build tools, benefits, considerations, Bash fallback configuration, and environment variable recommendations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request adds documentation for a new optional DevContainer feature that configures the common-utils image with Zsh as the default shell, including configuration details, benefits, considerations, and fallback options for teams preferring Bash.

Changes

Cohort / File(s)	Summary
DevContainer Recommendations Documentation .codex/devcontainer-recommendations.md	Adds new feature block "common-utils with Zsh" including configuration example, benefits (tab completion, plugins, history search, git integration), potential downsides, Bash fallback configuration, and recommended SHELL=/bin/zsh environment variable. Content inserted at two locations within the file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• feat: Add DevContainer recommendations and enhance config-base-sync-update #201: Modifies the same recommendations file and introduces comprehensive DevContainer feature documentation guidance
• fix: resolve devcontainer feature common installation issue #22: Addresses Zsh compatibility in the common feature's installation scripts and shell configuration

Suggested labels

released

Poem

🐰 A shell so zippy, with Z at the start,
Oh-My-Zsh sparkles like art!
Completion and themes, history so keen,
The finest dev prompt you've seen.
Hop faster, code quicker, with Zsh in the air! 🚀

Pre-merge checks

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and concisely summarizes the main change: adding a common-utils feature with Zsh configuration to DevContainer recommendations.
Linked Issues check	✅ Passed	The PR addresses the core objective from issue #226 by documenting the common-utils feature with Zsh configuration, benefits, and considerations in the recommendations file.
Out of Scope Changes check	✅ Passed	All changes are scoped to adding documentation for the common-utils Zsh feature to the DevContainer recommendations file, directly aligned with issue #226 objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

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

📒 Files selected for processing (1)

• .codex/devcontainer-recommendations.md

🧰 Additional context used

📓 Path-based instructions (1)

{.codex/**,.devcontainer/codex*,package*.json,npm/global.json}

📄 CodeRabbit inference engine (CLAUDE.md)

Use Conventional Commits format with release-triggering types (feat/fix/perf/revert/docs) for commits touching .codex/**, .devcontainer/codex*, package*.json, or npm/global.json

Files:

• .codex/devcontainer-recommendations.md

🧠 Learnings (3)

📓 Common learnings

Learnt from: CR
Repo: keito4/config PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T03:45:17.253Z
Learning: Applies to {.codex/**,.devcontainer/codex*,package*.json,npm/global.json} : Use Conventional Commits format with release-triggering types (feat/fix/perf/revert/docs) for commits touching .codex/**, .devcontainer/codex*, package*.json, or npm/global.json

Learnt from: CR
Repo: keito4/config PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T03:45:17.253Z
Learning: Applies to .github/workflows/docker-image.yml : Build DevContainer images automatically with semantic versioning and multi-platform support in .github/workflows/docker-image.yml

📚 Learning: 2025-12-01T03:45:17.253Z

Learnt from: CR
Repo: keito4/config PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T03:45:17.253Z
Learning: Applies to .github/workflows/docker-image.yml : Build DevContainer images automatically with semantic versioning and multi-platform support in .github/workflows/docker-image.yml

Applied to files:

• .codex/devcontainer-recommendations.md

📚 Learning: 2025-12-01T03:45:17.253Z

Learnt from: CR
Repo: keito4/config PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-01T03:45:17.253Z
Learning: Applies to {.codex/**,.devcontainer/codex*,package*.json,npm/global.json} : Use Conventional Commits format with release-triggering types (feat/fix/perf/revert/docs) for commits touching .codex/**, .devcontainer/codex*, package*.json, or npm/global.json

Applied to files:

• .codex/devcontainer-recommendations.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: claude-review

🔇 Additional comments (2)

.codex/devcontainer-recommendations.md (2)

265-321: Verify completeness against PR objectives.

The new "common-utils with Zsh" section provides solid configuration guidance and high-level benefits/considerations. However, the PR objectives specify three additional supporting materials that are not present:

1. Recommended Oh-My-Zsh plugins — Currently only mentions "豊富なプラグインエコシステム" without examples
2. Example .zshrc customizations — Not included
3. Troubleshooting guide — No Zsh-specific troubleshooting section

The current implementation covers configuration and decision-making context well, but lacks the detailed supporting materials described in issue #226's objectives.

Are the missing supporting materials (Oh-My-Zsh plugins, .zshrc examples, Zsh troubleshooting) intentionally deferred to a separate resource, or should they be included in this documentation? If they should be added here, I can help generate those sections with concrete examples and common gotchas for Zsh setup in DevContainers.

---

265-280: Commit message format is correct per coding guidelines.

The PR uses "feat:" which is an approved Conventional Commits release-triggering type for changes to .codex/** files. ✅

---

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 レビュー完了

このPRをレビューしました。全体的に高品質なドキュメント追加で、適切に構成されています。

✅ 良い点

1. 適切な配置

   • オプションFeaturesセクション(.codex/devcontainer-recommendations.md:265-320)に配置され、構造的に正しい
   • 1Password統合の前に配置され、論理的な順序を保っている

2. 包括的なドキュメント

   • 機能概要、利点、考慮事項、代替設定、利用シーンをカバー
   • Zsh派とBash派の両方に配慮した説明

3. コミット規約遵守

   • Conventional Commits準拠（feat:）
   • .codex/**変更のためfeatタイプの使用は適切（CLAUDE.md:12参照）
   • Co-Authored-Byでクレジット明記

4. Issue連携

   • Fixes feat: Add common-utils feature with Zsh as default shell #226 で適切にリンク
   • Issue #226の要件を完全に満たしている

📝 改善提案（軽微）

1. 一貫性の向上

   他のオプションFeaturesセクション（1Password統合、act）と比較すると、以下の情報が不足しています：

   ### common-utils with Zsh（開発者体験向上）
   
   + - 利用例: n8n_custom_node
   + - 用途: ターミナル操作の効率化、開発者体験向上

2. 技術的精度

   .codex/devcontainer-recommendations.md:304の記述について：

   Zshを無効にする場合は`configureZshAsDefaultShell`オプションを省略します。

   より正確には「省略」ではなく「デフォルト値（false）を使用」または「オプション自体を省略」です。現在の表現でも理解可能ですが、以下のように明示的にすることも検討できます：

   Zshを使用しない場合は`configureZshAsDefaultShell`を`false`に設定するか、オプション自体を省略します（デフォルトはBash）。

3. 環境変数の必須性

   .codex/devcontainer-recommendations.md:308-314の「推奨環境変数」について：

   SHELL環境変数の設定は通常、common-utilsフィーチャーが自動的に行うため、手動設定は不要な可能性があります。実際に必要かどうか確認することをお勧めします。不要であれば、このセクションを削除または「通常は自動設定されます」と注記を追加できます。

🔒 セキュリティ

• 問題なし（機密情報の露出なし）

🧪 テストカバレッジ

• ドキュメント変更のみのため、テスト不要
• ドキュメントの記述は正確で、設定例も有効

⚡ パフォーマンス

• Zshの起動が若干遅いことを既に文書化済み（.codex/devcontainer-recommendations.md:294）
• 実用上の影響は軽微と適切に記載

📊 品質基準

項目	状態
Conventional Commits	✅
Linked Issue	✅
Documentation	✅
Diff Size (57行追加)	✅ (≤400行)
Branch Naming	✅ feat/226-*

🎯 総合評価

承認推奨（Approve） - 軽微な改善提案はありますが、現状でもマージ可能な品質です。

改善提案は任意ですが、実装すると他のセクションとの一貫性が向上します。

---

🤖 Generated by Claude Code

[github-actions]

🎉 This PR is included in version 1.29.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀