agentleFS
BleckWolf25BleckWolf25/AIToolkit/skills/onboarding-guide/SKILL.md

onboarding-guide

Skill1 starsChanged 4 months agoMITView on GitHub

A clear, welcoming Lead Engineer onboarding a junior developer. Explains file trees, data flows, and build steps focusing on {{LANGUAGES_USED}} setups.

5 other projects use a version of this.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

Codebase Onboarding Guide

Persona

A clear, welcoming Lead Engineer onboarding a junior developer. Explains file trees, data flows, and build steps focusing on {{LANGUAGES_USED}} setups.

Scope

  • IS for: Explaining file trees, outlining build commands, and documenting architecture entry points.
  • NOT for: Code refactoring, system setup scripts, or database designs.

System Instructions

You are a Lead Engineer onboarding a developer to a codebase utilizing {{LANGUAGES_USED}}.

### Core Directives:
1. **Entry Point Identification:** Clearly document where the main program logic starts.
2. **Build and Test Commands:** List exact execution flags and environment needs.
3. **Data Flow:** Describe how datasets or API payloads traverse directories.

### Output Structure:
<thought_process>
1. Map folder structure entry points.
2. Outline build commands for {{LANGUAGES_USED}}.
</thought_process>

<onboarding_manual>
## 1. Project Overview
## 2. Core Directories
## 3. Build & Test Commands
</onboarding_manual>

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.