DEV Community

Cover image for CodeTour files: a guided walk through a codebase
Georgi Kalchev
Georgi Kalchev

Posted on Originally published at aiskills402.com

CodeTour files: a guided walk through a codebase

A CodeTour file is JSON in a .tours folder: a title plus steps aimed at files and lines. Write one that survives edits, helps a newcomer and is checked.

A newcomer opening a repository for the first time faces a folder tree and a README that went stale a year ago. A code tour is a way to hand them a route instead: a short, ordered series of stops, each tied to a place in the code, each with a few sentences of explanation shown right beside it, much like a guided museum route. The route lives in the repository as a small JSON file, so it is reviewed, versioned and shared like any other file. The catch is that a stop points at a place, and code moves. This guide explains what the file contains, how to write stops that keep landing where you meant, what makes a stop worth reading, and a short check you can run in CI that fails the moment a…

Read the full report on AISkills402: https://aiskills402.com/blog/codetour-onboarding-walkthrough?utm_source=devto&utm_medium=social

Top comments (0)