Skip to content

CONTRIBUTING

Contribute.

OpenLinker is open-source, Apache 2.0. Every commit matters. This guide mirrors CONTRIBUTING.md in the product repo.

  1. 01 First steps

    Clone the repo, run pnpm install, bring the dev stack up via pnpm dev:stack:up. Quickstart in the repo README.

  2. 02 DCO, not CLA

    We use the Developer Certificate of Origin — sign commits with git commit -s. No CLA. The sign-off certifies you have the right to submit the work under Apache 2.0.

  3. 03 Writing an adapter

    pnpm create-adapter <platform> generates the plugin structure. See docs/plugin-author-guide.md. The test-kit lets you test against real containers.

  4. 04 Reporting bugs

    GitHub Issues. Use the "bug" template. Include: version, reproduction steps, expected vs. actual behavior.

  5. 05 Pull requests

    Branch from main. Write tests. Sign-off commits. Keep scope small. Code review looks at architectural alignment (ADRs, framework-free domain).

  6. 06 Code of conduct

    Contributor Covenant. Be kind, be technically sharp. Zero tolerance for unkindness.

CONTRIBUTING.md