Contributing

April 7, 2026 · View on GitHub

This repository is a curated collection of copyable Ota examples.

What to submit

  • real examples that can be copied and adapted
  • templates that reflect a real repo shape
  • workspace, CI, and release patterns that match shipped Ota behavior
  • docs updates when the example changes the recommended flow

What to avoid

  • toy examples that do not map to a real workflow
  • duplicate patterns that do not add new value
  • examples that drift from the current CLI contract

Pull requests

  • Keep changes narrow and example-focused.
  • Update the example README and contract together.
  • Add a short note explaining why the example matters.
  • Prefer one example per pull request unless the change is purely editorial.
  • Run ota run validate before opening the pull request.
  • Run ota run dogfood when the change touches Ota UX, flagship examples, or adoption-facing copy.

Issues

  • Use the issue templates under .github/ISSUE_TEMPLATE for bugs and example requests.
  • Include the repo or workflow you want documented if the request is specific.

Review bar

  • The example should be real enough to copy.
  • The example should be explicit enough to modify safely.
  • The example should stay aligned with current ota behavior.
  • Flagship examples should still demonstrate obvious value on the current CLI, not only stay schema-valid.