Contributing

This contributor guide is for people changing nax itself. The project is a CommonJS Node CLI with JSDoc-typed JavaScript, a TypeScript/React dashboard, bundled workflow definitions, and a broad test suite around flow loading, transports, artifacts, and dashboard behavior.

Setup

git clone https://github.com/netlify-labs/nax.git
cd nax
npm install
npm link

Repository layout

• src
  • cli
  • workflows
  • integrations
  • dashboard
  • templates
• workflows
• tests
• docs

Required checks

npm run check
npm test
npm run dashboard:build

Code conventions

• All JavaScript must be typed with JSDoc annotations.
• Do not introduce any types. Use precise object shapes, callbacks, unknown, or explicit type imports.
• Keep CLI parsing thin and behavior in command handlers, workflow modules, integrations, or dashboard services.
• Keep bundled workflows readable. Prompt Markdown is part of the product surface.

See also

• Architecture for the main module boundaries.
• Workflow file reference for flow schema behavior.
• Use the dashboard for dashboard development.