Contributing a recipe

The recipe library grows by contribution — a new goal/machine-class pairing, or a better sensor choice for an existing one. See Authoring a recipe for the exact file shape and the rules every recipe must follow (generic sensor specs, cost ranges with a stated basis, real safety notes).

Before you open a pull request

1. Check the existing recipes under recipes/<goal>/ for one that already covers your goal and machine class — a near-miss is often better improved than duplicated.
2. Write the recipe YAML following Authoring a recipe.
3. Run uv run rw recipes lint recipes/ and fix every reported error.
4. Run npm -w docs run build and confirm your recipe’s generated page reads correctly and the build reports no broken links.

Review focus

A recipe review checks the same things the lint and build cannot: is the physics explanation actually correct for that machine class, is the mounting/wiring guidance safe and specific enough to follow, and are the example parts genuinely illustrative rather than a disguised recommendation for one vendor.

Translating a new recipe

A recipe’s i18n_keys list names exactly which fields need translation. See Contributing a translation for how that pipeline works — you do not need to translate your own recipe to contribute it.