Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.06 KB
Raw

Contributing

Thanks for helping improve opencode-goal-plugin.

Development

Use the pinned Node version when possible:

nvm use

Run the local checks before submitting changes:

npm test
npm run test:coverage
npm run type:check
npm run test:mutation
npm run smoke
npm run smoke:packed-host
npm run smoke:packed-tools
npm run benchmark:behavior
npm run verify
npm run check
npm run pack:check

For behavior changes, add or update tests in test/goal-plugin.test.js.

OpenCode Compatibility

This plugin depends on OpenCode plugin hooks, including experimental hooks. When changing hook usage, command behavior, or system-prompt transforms:

  1. Check the current OpenCode plugin and command documentation.
  2. Run npm run smoke, npm run smoke:packed-host, npm run smoke:packed-tools, and npm run type:check to verify the source and installed-tarball contracts.
  3. Test against a real OpenCode install when possible.
  4. Update the README compatibility snapshot if the tested surface changes.

npm run smoke verifies the package export path and /goal command hook without invoking a model. The packed-host and packed-tool checks install the npm artifact in isolated consumer projects and verify the public hook and complete optional-peer tool contracts. npm run type:check compiles installed-package consumers with NodeNext and Bundler resolution. npm run benchmark:behavior covers deterministic autonomy and token-efficiency scenarios. None replaces a real OpenCode smoke test after hook, SDK, or command behavior changes.

Release checklist

Before publishing or tagging a release, follow the release process. The required automated gate is:

  • run npm ci
  • update CHANGELOG.md and both package-version files
  • run npm run release:check
  • perform at least one manual OpenCode smoke test if hook behavior changed
  • refresh compatibility notes if the tested OpenCode surface changed

Pull Requests

Keep pull requests focused. Include:

  • what changed
  • why it changed
  • the checks you ran
  • any manual OpenCode smoke testing performed