Codebase exploration
Skill ChristopherAlphonse/calphonse-skills/codebase-exploration
I am a new developer onboarding onto this codebase. I want to explore it through its primary use cases first. Explore this repository and identify the most common, essential, and core use cases.From its SKILL.md
npx -y skills add ChristopherAlphonse/calphonse-skills --skill codebase-explorationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.5 KB, 254 tokens by cl100k_base, as published. Nobody here has run it
Objectives
Identify and document the repository's primary functionalities and workflows to facilitate developer onboarding.
Guardrails
- Ground every use case in files, routes, tests, docs, or observed behavior.
- Label assumptions and unknowns instead of filling gaps with guesses.
- Prefer the smallest useful onboarding map: core flows first, peripheral features later.
- Do not modify source code while exploring.
Required Content
- Core Use Cases: An ordered list of the most essential and frequent use cases supported by the codebase.
- User Journeys: Descriptions of typical end-to-end user paths through the system.
Execution Workflow
- Repository Exploration: Use
codebaseandsearchto map high-level architecture. - Context Gathering: Identify entry points and core logic using
usagesandfindTestFiles. - Documentation: Synthesize findings into the specified sections.
- Persistence: Write the final analysis to
.planning/system/use_cases.md.
Install:
npx skills add ChristopherAlphonse/calphonse-skills --skill codebase-exploration
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.