Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (27 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.05 KB
Raw

Contributing

Thanks for helping improve opencode-memory.

Setup

git clone https://github.com/jadmadi/opencode-memory
cd opencode-memory
bun test

Bun is a deliberate exception to the global no-bun rule here: the plugin runs inside OpenCode, which embeds Bun.

Rules

  • Import { Plugin } from "@opencode/plugin" and export Plugin.define({ id, setup }). The host provides the module at runtime; do not add it as a package dependency. Tests stub it in test-preload.ts.
  • Keep the three file names and the data directory layout stable.
  • Add a test for any behavior you change. Tests use MEMORY_ROOT.

Reporting a bug

Open an issue with your OpenCode version from opencode2 --version, the tool or command you used, and the result or error.

Sending a change

  1. Branch: git checkout -b fix/short-description.
  2. Make the change and add tests.
  3. Run bun test.
  4. Use a semantic commit message.
  5. Open a pull request against main.

License

By contributing, you agree that your work is released under the AGPL-3.0-only License.