code-tour-builder-plus

Built on affaan-m/ECC by @affaan-m (248,381 stars, MIT). All credit for the original idea to them. This fork improves and repackages it; upstream license preserved in UPSTREAM_LICENSE.

A Claude Code skill that builds clear CodeTour files from real code, files, and line numbers.

Made for developers, reviewers, support leads, and new team members. It plugs into your normal Claude Code flow.

💡 Why

Large codebases are hard to learn.

A short summary often skips the path that code takes. Hand-made tours can point to old files or wrong lines. Pull requests and bug fixes can also be hard to explain in a useful order.

This skill studies the real code path. It then creates one valid .tour file inside .tours/. It does not change your source code.

📦 Install

Run this one command from the cloned repo:

mkdir -p ~/.claude/skills/code-tour && curl -fsSL https://raw.githubusercontent.com/affaan-m/code-tour-builder-plus/main/skill/SKILL.md -o ~/.claude/skills/code-tour/SKILL.md

🚀 Usage

Open Claude Code in your project and ask:

Make a pull request tour for the new password reset flow.

Claude checks the changed files, callers, saved data, error paths, and tests. It writes one file:

.tours/password-reset-pr.tour

The result is valid JSON. Each step points to a real file and line:

{
  "title": "Password reset pull request",
  "description": "A short tour for reviewers.",
  "steps": [
    {
      "file": "src/routes/password-reset.ts",
      "line": 24,
      "description": "The reset request starts here. This route checks the input before calling the reset service. Next, open the service to see how the token is made."
    }
  ]
}

The skill can also build tours for onboarding, one feature, system design, or a bug root cause review.

🔧 What we changed vs upstream

• 日本語中心だった説明を、より平易で具体的な英語に全面的に書き直した。
• ECC由来であることを明示するクレジット文と、変更・共有時に残す指示を追加した。
• 読者や目的が曖昧な場合の確認方針、テスト・ログ・修正箇所まで含む調査項目を追加した。
• ツアー種別ごとの推奨ステップ数と、PR・不具合調査向けの具体的な構成順を拡充した。
• 実在するファイル／行の検証基準、安定したアンカーの選び方、命名規則、JSON例を追加した。

📄 License

Released under the MIT License. The upstream MIT license and credit are preserved in UPSTREAM_LICENSE.