SuperAPI AI Directory

register-project

General & other

View repository

Updated 10-15 23:49

About this skill

Task

Register the project $1 in the monorepo infrastructure.

Process

1. Verify Project Exists

Check that packages/<domain>/$1/ exists and has the basic structure:

  • CMakeLists.txt or ESPHome .yaml file
  • main/ directory (for ESP-IDF projects)
  • justfile

2. Register in Root justfile

Add a mod line to the root justfile if not already present:

mod project-name 'packages/<domain>/project-name'

Place it alphabetically among the existing mod declarations. Use the justfile recipe naming convention (lowercase-kebab-case).

3. Verify CI Build Workflow

Each ESP32 project has its own .github/workflows/build-<project>.yml (calling the reusable _ci-build-esp32.yml). If the project should be built in CI:

  • Verify .github/workflows/build-<project>.yml exists
  • Or note that it needs to be created (copy an existing one such as build-melody-detector.yml; don't auto-edit workflow files without confirmation)

4. Check Standard File Inventory

Report which standard files exist and which are missing:

File Status
justfile exists / missing
CMakeLists.txt exists / missing
sdkconfig.defaults exists / missing
version.txt exists / missing
README.md exists / missing
CLAUDE.md exists / missing
WIRING.md exists / missing / n/a
.gitignore exists / covered by root

5. Suggest Follow-up Skills

For missing files, suggest the appropriate skill:

  • Missing README → /project-readme $1
  • Missing CLAUDE.md → /project-claude-md $1
  • Missing WIRING.md → /wiring-doc $1
  • Missing sdkconfig.defaults → /sdkconfig-audit $1
  • Missing credentials setup → /credential-setup $1

Output

## Project Registration: <project-name>

### Registration
- Root justfile: ADDED (mod line inserted)
- CI matrix: Present / NEEDS MANUAL ADD

### File Inventory
| File | Status |
|------|--------|
| ... | ... |

### Suggested Next Steps
- Run `/project-claude-md <name>` to generate CLAUDE.md
- ...