Skip to content

Authoring Workflow

The recommended workflow is intentionally simple:

text
init -> generate -> validate --strict -> test -> handoff

What Each Step Means

StepPurpose
initCreate a package-standard project layout
generateGenerate target artifacts from the project source
validate --strictRun the main readiness check
testRun stable smoke tests where applicable
export / bundle flowProduce handoff artifacts for supported Python and Node cases

Rules That Keep The Repo Healthy

  • the project source lives in the package-standard project layout
  • generated target files are outputs, not the long-term source of truth
  • strict validation is a required check, not an optional extra

This workflow matters equally for single-target and multi-target repos.

The only difference is that in a multi-target project, the generate and validate loop is repeated for each target the repo actually promises to support.

When The Workflow Changes

The workflow can widen for special cases:

  • doctor and bootstrap matter for Python and Node runtime paths
  • import and normalize matter when consolidating hand-managed target files into the managed project model
  • bundle commands matter for portable Python and Node handoff flows

Start with Quickstart when you need the shortest path.

Public docs for plugin authors and integrators.