codebase-onboarding SKILL.md skillA

codebase-onboarding from wst2002/claude-code-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add wst2002/claude-code-skills/codebase-onboarding@git:20261016.55bd98a

Pins git:20261016.55bd98a in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
wst2002/claude-code-skills
Path
skills/codebase-onboarding/SKILL.md
Versions recorded
2
Latest version
git:20261016.55bd98a, committed Oct 16, 2026
First version recorded
Oct 16, 2026
Size
2,646 bytes
Repository stars
3
License
MIT

Use when joining or exploring an unfamiliar codebase, asked to explain how a project works, where something is implemented, how to run it locally, or to create an onboarding guide for new team members.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Codebase Onboarding

## Overview

Give a new developer a working mental model in minutes: what the project does, how it is organized, how a request flows through it, how to run it, and where to make common changes. Every claim points to a file.

## Method

1. **Identify the project:** README, manifests (`package.json`, `pom.xml`, `pyproject.toml`, `go.mod`), languages, frameworks, versions.
2. **Find how it runs:** scripts, `Makefile`, `docker-compose.yml`, `.env.example`, CI workflow (the CI file shows the real build and test steps).
3. **Map the structure:** top-level folders and what each owns. Find the entry points (server start, routes, CLI main, app root).
4. **Trace one real flow end to end:** for example an HTTP request from route → handler → service → database → response, with file paths.
5. **Find the conventions:** state management, data access, error handling, logging, testing style, naming.
6. **List the gotchas:** required services, generated code, environment quirks, slow or flaky parts, areas without tests.
7. **Write the guide** with the format below. Verify the run commands exist.

## Output format

```
# <Project> — onboarding

## What it is
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add wst2002/claude-code-skills/codebase-onboarding@sha256:2e1e54f395d0d4a7

The line at the top of this page pins the label git:20261016.55bd98a, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_urhqoulsndlwh2gz.svg)](https://markdownregistry.com/a/art_urhqoulsndlwh2gz)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, all committed on Oct 16, 2026.

versioncommittedcommitsizeaudit
git:20261016.55bd98a latest2026-10-16 55bd98a 2,646 BA view · diff
git:20261016.de13fc32026-10-16 de13fc3 2,444 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (2646 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

wst2002/claude-code-skills · 3 stars · license MIT · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_urhqoulsndlwh2gz
GET https://markdownregistry.com/api/v1/resolve?ref=wst2002/claude-code-skills/codebase-onboarding
GET https://markdownregistry.com/api/v1/blob/2e1e54f395d0d4a7862ec73192f9d492b716d6c8e4ed228e6f2436c1fa37d894

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from wst2002/claude-code-skills

proof-of-done SKILL.md skill
wst2002/claude-code-skills · plugins/proof-of-done/skills/proof-of-done/SKILL.md · Use before saying work is done, fixed, or complete after changing code. Run the project's checks, show their results…
git:20261016.55bd98a · audit A · 3 stars
accessibility-audit SKILL.md skill
wst2002/claude-code-skills · skills/accessibility-audit/SKILL.md · Use when checking a website, web app or UI component for accessibility, WCAG or a11y compliance, screen reader or…
git:20261016.55bd98a · audit A · 3 stars
api-design-review SKILL.md skill
wst2002/claude-code-skills · skills/api-design-review/SKILL.md · Use when designing a new REST API, reviewing endpoints, routes, controllers or an OpenAPI/Swagger spec, choosing status…
git:20261016.55bd98a · audit A · 3 stars
api-test-writer SKILL.md skill
wst2002/claude-code-skills · skills/api-test-writer/SKILL.md · Use when writing automated API tests or integration tests for REST or GraphQL endpoints, testing from an…
git:20261016.55bd98a · audit A · 3 stars
architecture-diagram SKILL.md skill
wst2002/claude-code-skills · skills/architecture-diagram/SKILL.md · Use when asked to draw, diagram or visualize a system, codebase, architecture, data flow, request flow, database ERD…
git:20261016.55bd98a · audit A · 3 stars
bug-debugger SKILL.md skill
wst2002/claude-code-skills · skills/bug-debugger/SKILL.md · Use when something is broken, a test fails, an error or stack trace appears, behavior is wrong or intermittent, a…
git:20261016.55bd98a · audit A · 3 stars
bug-report-writer SKILL.md skill
wst2002/claude-code-skills · skills/bug-report-writer/SKILL.md · Use when writing or improving a bug report, defect ticket or Jira/GitHub issue from notes, screenshots, logs, a video…
git:20261016.55bd98a · audit A · 3 stars
changelog-writer SKILL.md skill
wst2002/claude-code-skills · skills/changelog-writer/SKILL.md · Use when writing release notes, a CHANGELOG.md entry, a version summary or "what's new" text from git history, merged…
git:20261016.55bd98a · audit A · 3 stars
code-review SKILL.md skill
wst2002/claude-code-skills · skills/code-review/SKILL.md · Use when asked to review a pull request, a branch, a diff, staged changes or recent commits, check code before merging…
git:20261019.d667a4e · audit A · 3 stars
database-schema-design SKILL.md skill
wst2002/claude-code-skills · skills/database-schema-design/SKILL.md · Use when designing a database from scratch, reviewing tables, an ERD, a Prisma/TypeORM/JPA/Django/SQLAlchemy schema or…
git:20261016.55bd98a · audit A · 3 stars
dependency-upgrade SKILL.md skill
wst2002/claude-code-skills · skills/dependency-upgrade/SKILL.md · Use when upgrading packages, libraries, a framework or a language runtime (React, Next.js, Angular, Spring Boot…
git:20261016.55bd98a · audit A · 3 stars
dockerize-app SKILL.md skill
wst2002/claude-code-skills · skills/dockerize-app/SKILL.md · Use when asked to dockerize or containerize an app, write or fix a Dockerfile or docker-compose.yml, shrink a large…
git:20261019.75b8541 · audit A · 3 stars

Every file in wst2002/claude-code-skills

Other files named codebase-onboarding

codebase-onboarding SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/codebase-onboarding/SKILL.md · 不慣れなコードベースを分析し、アーキテクチャマップ、主要なエントリポイント、規約、スターターCLAUDE.mdを含む構造化オンボーディングガイドを生成します。新しいプロジェクトに参加するか、リポでClaude…
git:20260517.ec9ace9 · audit A · 284,510 stars
codebase-onboarding SKILL.md skill
alirezarezvani/claude-skills · .gemini/skills/codebase-onboarding/SKILL.md
git:20260509.0c7d19d · audit C · 28,445 stars
codebase-onboarding SKILL.md skill
borghei/claude-skills · engineering/codebase-onboarding/SKILL.md · Analyze a codebase and generate onboarding docs: architecture overviews, file maps, setup guides, runbooks, and…
v1.1.0 · audit A · 954 stars
codebase-onboarding SKILL.md skill
ericrisco/rsc-harness · skills/codebase-onboarding/SKILL.md · Use when you land in an unfamiliar or inherited codebase and must get productive fast: a breadth-first map of entry…
git:20260729.3ecb845 · audit A · 236 stars
codebase-onboarding SKILL.md skill
seaworld008/commonly-used-high-value-skills · openclaw-skills/codebase-onboarding/SKILL.md · Create repository onboarding guides with architecture, key files, setup, debugging, and contribution workflows for a…
v1.0.1 · audit B · 73 stars

Browse by kind, by grade A, or by owner.