onboard

name	onboard
description	Set up PictoPy for the first time and tour the codebase. Use when a contributor is new to the project, is setting up their environment, or asks where something lives.
disable-model-invocation	true
allowed-tools	Bash Read Grep Glob

Onboard

Get a new contributor from a fresh clone to a running app, and orient them in the codebase. Ask before running anything that installs or downloads.

1. Before any code

Tell the contributor the process rule up front, because it is the one that wastes the most effort when missed:

Do not open a PR for an issue that maintainers have not reviewed and labelled. Comment on the issue and wait for the green light first.

PRs target main, and the PR body must reference its issue as #<number>.

2. Prerequisites

Check what is already installed and report what is missing:

node --version
python --version
cargo --version

Node 18+, Python 3.11, and a Rust toolchain are all needed for a full build. A frontend-only contributor can skip Python; a backend-only contributor can skip Rust.

3. Setup

Two supported paths:

• Scripted (Windows, Debian/Ubuntu, Fedora/RHEL) — docs/Script_Setup_Guide.md. From the repository root: npm run setup.