Workflow Development

Scaffold a Module

Process for creating a new module or package from scratch

scaffoldmodulearchitecture
CLAUDE.md

When creating a new module:

  1. Check existing modules for naming conventions, directory structure, and patterns to follow.
  2. Create the directory with the standard file structure used in this project.
  3. Create the main entry point file with the public API exports.
  4. Add a test file with at least one smoke test.
  5. Wire the module into the project’s build, import maps, or package configuration.
  6. Run the build to verify the new module compiles and integrates.
  7. Add a brief comment in the entry file describing the module’s purpose and responsibilities.

Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.

get crystl