onboard-repo

Featured

Index an unfamiliar codebase into the knowledge graph, then produce a first orientation map -- entry points, most-depended-upon modules, hotspots, test topology.

AI & Automation 66 stars 9 forks Updated 4 weeks ago Apache-2.0

Install

View on GitHub

Quality Score: 88/100

Stars 20%
61
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Onboard Repo Take a codebase you have never seen and turn it into a queryable graph, then read the graph to produce an orientation map. Use this on first contact with a repository, before answering questions about it or changing anything in it. **Scope:** this skill builds and reads a knowledge graph. It does not modify source files, CI configuration, or project conventions. The only files it creates are the graph database under `.code-review-graph/` (already self-ignored) and, when you choose to add one, a `.code-review-graphignore`. **Command surface:** run the local CLI through the coding harness shell. Examples use the installed `better-code-review-graph` command; from a source checkout, prefix it with `uv run`. No MCP mapping is required. ## Steps 1. **Check what already exists** with `better-code-review-graph graph stats --repo-root "<path>"`. A non-empty graph can go directly to step 5; a missing-graph error means continue with a build. 2. **Decide the indexing scope before building**: - Single repository: pass only `--repo-root "<path>"`. - A repository that vendors or embeds others: add a `.code-review-graphignore` at the repo root (one `fnmatch` pattern per line, `#` for comments) so vendored trees, build output, and fixtures do not inflate the graph. Common additions: `vendor/*`, `third_party/*`, `**/generated/*`, `**/*.min.js`. - Several sibling repositories that call each other: federate them in one graph with `--roots` in step 3, then use `impac...

Details

Author
n24q02m
Repository
n24q02m/better-code-review-graph
Created
6 months ago
Last Updated
4 weeks ago
Language
Python
License
Apache-2.0

Bundled in these plugins

Related Skills