new-module

Files (1)

• SKILL.md

SKILL.md (first lines)

# Create a module

## Before you start

- An accepted ADR in `docs/decisions/` names the module, its tier (core, optional or community) and the prior art
  that was checked. Without it, stop and use `skills/write-adr`.

## Steps

1. `make new-module NAME=<name>`. This copies the working module `modules/_template/` (ADR 0015), renames it and
   registers the module ID prefix in `docs/reference/scenario-prefixes.md`. The new module's quick-start test
   passes from the start; replace its `hello` command with the module's first real command.
2. Fill in `README.md`: the one problem the module solves alone, the quick start, inputs and outputs.
3. Fill in `AGENTS.md` for the module: public surface, allowed exceptions (for example unit tests for a parser),
   time budget for its system tests. Keep the "Quality limits" (duplication and mutation score) and the
   `mutation` script in `package.json` from the template; DUP and MUTATION fail without them (ADR 0037).
4. Pick the module's layers in `architecture.json` (ADR 0014). The template starts with `entry` → `adapters` →
   `domain`; change it when the module needs another shape. A file may import its own layer and the layers below
   it. The ARCH check enforces this.
5. Write the first scenario: the five-minute quick start from the README, with `skills/write-scenario`.
   Every module's `SCN-<MODULE>-001` is its quick start.
6. Continue with `skills/write-system-test` and `skills/implement-scenario`.

## Rules

- A module is useful alone. If it needs another module to be useful, it is part of that module.
- The public surface is declared in `README.md` and `contracts/`: CLI commands, HTTP endpoints, MCP tools,
  events, input and output folders. Everything else is private.
- An adapter implements one port and passes that port's `@conformance` scenarios.

From sesigl/open-software-factory, Apache-2.0.

More from sesigl/open-software-factory