FAQ

Home > FAQs > Contributing

How do I contribute to OpenCues?

OpenCues is open source under Apache-2.0, and it's built to accept contributions at every skill level: the easiest meaningful contribution is one markdown file, and the largest is a whole new editor integration.

Start with a config file, not code

A new word source is one cues/<name>/CUE.md: it's auto-discovered, routed per-word, and hot-reloads in a couple of seconds. A keyword blank is the same shape. Issues labelled good first issue collect starters like these, along with docs fixes and test cases.

The three contribution areas

  • The standard: the .md formats themselves. Changes go through a lightweight proposal process (copy spec/proposals/template.md, show concrete before/after, open a PR); accepted proposals must ship conformance fixtures.
  • Integrations: bring OpenCues to a new editor or app. The host contract is about 160 lines in the lightest shipped adapter, and the porting guide covers the pitfalls.
  • The core libraries: the resolver, sources, and runtime modules, with 700+ tests across the two packages.

House rules

Keep PRs focused (one feature or fix each). Test what you ship, end to end, and say what you tested. Never break hot-reload: config edits must not require a restart. Everything else is in CONTRIBUTING.md.

Related: The open standard · Write your own cue · Who made OpenCues? · Implement the standard · GitHub repo