Skip to main content

Contributing

This guide improves through recipes that someone has run in practice. Contributions are welcome through GitHub issues and pull requests to the cookbook/ folder of the repository. The authoring guide sets the standard for structure and writing.

Criteria for a recipe​

  • It produces a defined result that a reader can check.
  • It names the level, the skills needed, and a realistic time.
  • It uses open standards and names alternatives where they exist.
  • Code runs with the stated dependencies and uses the running example where possible.
  • Claims that something improves a measure link to the measurement.

Recipe template​

<Recipe title="N.M Title that names the result" level="Foundational | AI-ready | AI-native" skills="Who can do this" time="How long">

**Result:** one sentence on what exists when the recipe is done.

1. Step.
2. Step, with code or a template where useful.
3. How to check that it worked.

**What this does not do.** Where the example stops and what the full version adds.

</Recipe>

Corrections​

Corrections to standards references, measures, or code are the most useful contribution. Open an issue with the page, the sentence, and the source that shows the correction.

Examples from organizations​

If an organization has implemented something in this guide, a short description (what was done, what changed in the measures, what would be done differently) can be added as an example in the relevant chapter. Say what may be published and under what name.