Contributing
Rules
The repo is moving quickly. Rules are simple:
- Keep the starter opinionated — don't add options for everything
- Prefer incremental module extraction over full rewrites
- Do not merge changes that break smoke verification
Development setup
git clone https://github.com/jocage/launchframe.git
cd launchframe
pnpm installSmoke testing
Before submitting changes, verify all profiles pass:
pnpm smoke:verify:blank
pnpm smoke:verify:dashboard
pnpm smoke:verify:postgresjsEach smoke test generates a project, installs deps, and runs lint, typecheck, test, and build.
CLI packaging
pnpm cli:sync-assets # sync modules/presets/templates to apps/cli/
pnpm cli:pack # pack the CLI tarball
pnpm cli:publish:dry-runAdding a module
- Create
modules/<name>/module.jsonwith metadata - Add files to
modules/<name>/files/ - Add the module to relevant presets in
presets/*.json - Add token replacements if needed
- Run smoke tests
- Sync CLI assets:
pnpm cli:sync-assets
Release process
See the Release Guide for the full checklist.
Version policy
- patch: packaging fixes, docs, non-breaking template fixes
- minor: new scaffold options, new modules, additive generated files
- major: breaking generated output contracts, removed options