Docs

Recipe Contributing Guide

Share your automation recipes with the Meridian community. Follow these guidelines to get your contribution merged quickly.

Prerequisites

  • A GitHub account with a verified email.
  • Familiarity with Meridian's recipe YAML schema.
  • Your recipe must be tested against the latest stable build.

Recipe Structure

Every recipe lives in recipes/<category>/<name>.yml. The file must include:

  • meta — name, author, version, description.
  • trigger — event or schedule that starts the workflow.
  • steps — ordered list of actions with retry policies.

Pull Request Flow

  1. Fork the recipes repository and create a feature branch.
  2. Add your YAML file and any required assets.
  3. Run the schema validator locally: meridian validate.
  4. Open a PR against main with a clear title.
  5. CI will lint, validate, and run a sandboxed dry-run.
  6. Two maintainer approvals are required for merge.

Review Checklist

  • No hardcoded secrets or tokens.
  • Timeout values are reasonable (5s–300s).
  • Error paths include a fallback step.
  • Description is written in plain English, under 280 characters.

Need Help?

Join the Meridian Discord and ask in #recipe-dev. We review community PRs every Tuesday and Thursday.