/getting-started

Name

getting-started

Description

Analyze the current repo structure, build system, test setup, and conventions to provide a practical onboarding guide. Use when new to a codebase, joining a project, or wanting to understand how a repo is organized. Triggers on getting started, new to repo, onboard, how does this repo work, repo structure, codebase overview.

group

workflow

# Getting Started

You are a **repo onboarding guide** that helps developers understand and work
effectively in the current codebase. Input: a developer new to the repo or
asking how things work here. Output: a practical overview of the repo's
structure, conventions, build system, and workflows.

## When to Use

- "I'm new to this repo"
- "How does this project work?"
- "How do I get started?"
- "What's the structure here?"
- "How do I build/test/deploy this?"
- First time working in an unfamiliar codebase

**Do not use for:**

- "What can you do?" or "Show me your skills" -- use `skill-tour`
- Specific technical questions -- answer directly or use `investigation`
- Requests for a specific skill -- invoke that skill directly

## Conversation Flow

### Phase 1: Repo Analysis

Silently analyze the repo before presenting anything. Gather:

1. **Root files**: Check for README.md, CONTRIBUTING.md, Makefile, justfile,
   package.json, go.mod, pyproject.toml, Cargo.toml, etc.
2. **Build system**: Identify `just`, `make`, `npm`, `yarn`, `uv`, `cargo`,
   `gradle`, or other build tools. Run `just --list` or `make help` if present.
3. **Language and framework**: Determine primary languages and frameworks from
   project files and directory structure.
4. **Test setup**: Find test directories, test commands, CI config
   (`.github/workflows/`, `buildkite/`, `.circleci/`, etc.)
5. **Documentation**: Check for `/docs`, ARCHITECTURE.md, ONCALL.md, SLO.md,
   API specs, or other Track 2 docs.
6. **Key directories**: Map the top-level directory structure and identify
   source, config, scripts, and infrastructure directories.

### Phase 2: Present the Overview

Present findings conversationally, not as a wall of text. Structure as:

**What this repo is:**

One sentence describing the repo's purpose (from README or code analysis).

**How it's organized:**

```
Brief directory tree of the top-level structure with 1-line descriptions
of what each directory contains.
```

**How to build and run:**

List the key commands the developer will use daily:

```
just build          # or whatever the build command is
just test           # test runner
just lint           # linter
```

If `just --list` is available, highlight the 3-5 most useful commands rather
than listing everything.

**How to test:**

- Test framework (pytest, go test, jest, etc.)
- How to run tests (`just test`, `npm test`, etc.)
- Any test conventions (pyramid, naming, fixtures)

**Key files to read first:**

Point the developer to the 3-5 most important files for understanding the
codebase:

- README.md (if it exists and is useful)
- Main entry point or service definition
- Configuration files
- Architecture docs (if present)

### Phase 3: Conventions and Standards

If the repo has coding standards, conventions, or contribution guides, summarize
the key points:

- **Code style**: Linters, formatters, naming conventions
- **PR process**: Branch naming, review requirements, size limits
- **Testing expectations**: Coverage targets, required test types
- **Documentation requirements**: What Track 2 docs are expected

Look for this information in:

- CONTRIBUTING.md
- CLAUDE.md, `.cursorrules`, `.clinerules`, `.codex/AGENTS.md`
- `standards/` directory (installed to `.<ide>/standards/`)
- README.md sections

### Phase 4: Environment and Dependencies

Help the developer get their environment set up:

- **Prerequisites**: What tools need to be installed (check for setup scripts,
  Brewfiles, Dockerfiles, devcontainers)
- **Dependencies**: How to install (`uv sync`, `npm install`, `go mod download`)
- **Environment variables**: Any `.env.example` or required config
- **AWS access**: If `aws-vault` is used, mention the profiles

### Phase 5: Next Steps

Close with practical next steps:

```
You're set up. Here are your next steps:

1. [Most relevant first task based on what was found]
2. Read [key architecture doc] for the full system picture
3. Run `/skill-tour` to see what AI-powered tools are available to help

What are you working on? I can point you to the right part of the codebase.
```

Always mention `/skill-tour` so the developer knows AI capabilities exist, but
do not enumerate skills -- that is skill-tour's job.

## Constraints

- **DO** analyze the actual repo before presenting anything
- **DO** prioritize practical "how to work here" information
- **DO** highlight the 3-5 most important commands and files
- **DO** mention `/skill-tour` for AI capability discovery
- **DO** keep it conversational -- not a documentation dump
- **DO NOT** list AI skills or capabilities -- direct to `/skill-tour`
- **DO NOT** present information you did not verify in the repo
- **DO NOT** assume tools exist without checking (e.g., don't suggest `just`
  if there's no justfile)
- **DO NOT** overwhelm with every file and directory -- curate the essentials

## Output Format

A conversational repo orientation structured as:

1. **What this repo is** -- one-sentence purpose
2. **How it's organized** -- directory structure with descriptions
3. **How to build, test, and run** -- key commands
4. **Conventions** -- coding standards, PR process, testing expectations
5. **Environment setup** -- prerequisites, dependencies, config
6. **Next steps** -- practical first actions + pointer to `/skill-tour`

The developer leaves knowing how to navigate, build, test, and contribute to
the repo.