Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.38 KB
Raw

Contributing

Contributions are welcome. Keep changes focused and open an issue before starting work that changes the public behavior or architecture.

Development

Requirements:

  • Bun 1.3.14
  • the OpenCode V2 build pinned in package.json
bun install --frozen-lockfile
bun run check

The V2 plugin API is host-coupled. Do not update @opencode-ai/*, Effect, or OpenTUI dependencies as an ordinary dependency bump; update them together and verify the plugin inside the matching OpenCode release.

Pull requests

  1. Branch from develop.
  2. Use a Conventional Commit pull request title, such as fix: preserve waits after restart.
  3. Add or update tests for behavior changes.
  4. Run bun run check.
  5. Open the pull request against develop.

Pull requests into develop are squash-merged. master only accepts the release pull request from develop, using a merge commit. Direct pushes to either protected branch are disabled.

Releases

  • Every eligible push to develop publishes a unique npm dev snapshot.
  • A version tag on master publishes the reviewed npm beta release.
  • Nothing publishes to npm latest while OpenCode V2 remains beta.

Maintainers prepare a reviewed release by merging develop into master, then creating and pushing the version tag from master.

Security

Do not report vulnerabilities in a public issue. Follow SECURITY.md.