Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (41 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.09 KB

Contributing to @amaan/plugin-sdk

Local setup

npm install

Build

npm run clean
npm run build

Project structure

  • src/core/: shared internal abstraction utilities
  • src/index.ts: top-level thin exports
  • opencode/src/: OpenCode adapter
  • opencode/examples/: OpenCode examples
  • pi/src/: PI adapter
  • pi/examples/: PI examples

Using local SDK in another project

From a consumer project package.json:

{
  "dependencies": {
    "@amaan/plugin-sdk": "file:../plugin-sdk"
  }
}

Then run:

npm install

Adding a new platform adapter

  1. Add adapter source under <platform>/src/.
  2. Add minimal examples under <platform>/examples/.
  3. Reuse src/core primitives where possible.
  4. Add package export subpath in package.json.
  5. Update tsconfig.json include paths.
  6. Build and smoke-test imports.

Safety guidelines

  • Do not add helpers that imply runtime capabilities not present in the target platform.
  • Keep adapter behavior aligned to official platform docs.
  • Prefer explicit helper names over overloaded behavior.