JavaScript is disabled. Some features may not work.
code-tour — ★ 220.5K GitHub Stars — Install Guide | SkillsNav
🇺🇸 English🇨🇳 中文
SkillsNav
Home

code-tour

★ 220K reporeadmeN/ABeginnerClaude
🤖 AI Summary

Creates `.tour` JSON files in `.tours/` that define guided, step-by-step codebase walkthroughs, with each step opening to a specific file and line range. It generates narrative artifacts for onboarding, architecture review, or PR explanation, and does not modify any source code.

How to Install

Claude Code:
git clone --depth 1 https://github.com/affaan-m/ECC.git && cp ECC/skills/code-tour ~/.claude/skills/code-tour -r
# Code Tour Create **CodeTour** `.tour` files for codebase walkthroughs that open directly to real files and line ranges. Tours live in `.tours/` and are meant for the CodeTour format, not ad hoc Markdown notes. A good tour is a narrative for a specific reader: - what they are looking at - why it matters - what path they should follow next Only create `.tour` JSON files. Do not modify source code as part of this skill. ## When to Use Use this skill when: - the user asks for a code tour, onboarding tour, architecture walkthrough, or PR tour - the user says "explain how X works" and wants a reusable guided artifact - the user wants a ramp-up path for a new engineer or reviewer - the task is better served by a guided sequence than a flat summary Examples: - onboarding a new maintainer - architecture tour for one service or package - PR-review walk-through anchored to changed files - RCA tour showing the failure path - security review tour of trust boundaries and key checks ## When NOT to Use | Instead of code-tour | Use | | --- | --- | | A one-off explanation in chat is enough | answer directly | | The user wants prose docs, not a `.tour` artifact | `documentation-lookup` or repo docs editing | | The task is implementation or refactoring | do the implementation work | | The task is broad codebase onboarding without a tour artifact | `codebase-onboarding` | ## Workflow ### 1. Discover Explore the repo before writing anything: - README and package/app entry points - folder structure - relevant config files - the changed files if the tour is PR-focused Do not start writing steps before you understand the shape of the code. ### 2. Infer the reader Decide the persona and depth from the request. | Request shape | Persona | Suggested depth | | --- | --- | --- | | "onboarding", "new joiner" | `new-joiner` | 9-13 steps | | "quick tour", "vibe check" | `vibecoder` | 5-8 steps | | "architecture" | `architect` | 14-18 steps | | "tour this PR" | `pr-reviewer` | 7-11 steps | | "why did this break" | `rca-investigator` | 7-11 steps | | "security review" | `security-reviewer` | 7-11 steps | | "explain how this feature works" | `feature-explainer` | 7-11 steps | | "debug this path" | `bug-fixer` | 7-11 steps | ### 3. Read and verify anchors Every file path and line anchor must be real: - confirm the file exists - confirm the line numbers are in range - if using a selection, verify the exact block - if the file is volatile, prefer a pattern-based anchor Never guess line numbers. ### 4. Write the `.tour` Write to: ```text .tours/-.tour ``` Keep the path deterministic and readable. ### 5. Validate Before finishing: - every referenced path exists - every line or selection is valid - the first step is anchored to a real file or directory - the tour tells a coherent story rather than listing files ## Step Types ### Content Use sparingly, usually only for a closing step: ```json { "title": "Next Steps", "description": "You can no

Details

Category Docs → readme
Sourceaffaan-m/ECC
SKILL.mdView on GitHub →
Repo Stars★ 220.5K
Est. per SkillN/A (shared across 121 skills from this repo)
DifficultyBeginner
Risk LevelN/A

Related Skills

Works Well With

Skills from the same repository — often designed to work together