agentleFS
Sign inStart free
kuker24kuker24/OpenCodeBestFriend/skills/code-tour/SKILL.md

code-tour

Skill0 starsChanged 2 months agoMITView on GitHub

Create CodeTour `.tour` files — persona-targeted walkthroughs with verified file and line anchors under `.tours/`. Use for onboarding, architecture, PR, RCA, or "explain how this works" when a reusable guided artifact is wanted. Not for chat-only explanations, prose docs (technical-writing), or implementation work.

27 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Write CodeTour JSON under .tours/.

    line 10
  2. Distinctive:

    When answering "how does X work?" or "where does X live?" where a reusable guide is valuable:

    line 35

“Common” is measured: kept by at least 6 in 10 of the 27 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Code Tour

Write CodeTour JSON under .tours/. Tours open real files and line ranges. Do not modify source as part of this skill.

Boundaries & Handoffs

NeedRoute
One-off explanation in chatanswer directly; no tour
Prose documentation structure/technical-writing
Implementation or refactordo the work; do not start a tour
Reusable .tour walkthrough with file anchorscode-tour

Procedure

Consult references/format.md for step types and ref.

  1. Discover. README, entry points, layout, and (for PR tours) changed files. Do not write steps before the shape is known.
  2. Infer the reader. New joiner 9–13 steps; quick tour 5–8; architecture 14–18; PR/RCA/security/feature 7–11.
  3. Verify every anchor. File exists, line in range, selection exact. Prefer a pattern when lines drift. Never guess line numbers.
  4. Write .tours/<persona>-<focus>.tour.
  5. Validate. First step is a real file or directory. ref points at a revision that actually contains every referenced file. PR tours use the PR branch, never the base.

Each description answers situation, mechanism, implication, gotcha. Narrative: orientation → module map → core path → gotcha → next move.

"How It Works" & "Where It Lives" Tours

When answering "how does X work?" or "where does X live?" where a reusable guide is valuable:

  • Step 1: Entry point or trigger (where the request enters).
  • Step 2: Core invariant or state transformation (the underlying mechanism).
  • Step 3: Persistence, side-effect, or external call (destination).
  • Step 4: Edge case or gotcha (what trips newcomers). Ground every step in verified file and line anchors.

Output

A valid .tour file plus a one-line confirmation that every path and line was checked against the chosen ref (or against the working tree when ref is omitted).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free