Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 926 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 926 Bytes
Raw

Contributing

Development

pnpm install
pnpm check

Use Node.js 22 or later. Keep changes scoped to one protocol or provider concern and add tests for observable behavior.

Contract Changes

Public protocol changes must include:

  1. the schema or state-machine change;
  2. reference runtime behavior;
  3. HTTP and SDK updates when affected;
  4. conformance coverage;
  5. migration or compatibility notes.

Provider-specific features should first be represented as a capability or an extension event. Do not expand the portable core solely to mirror one framework.

Pull Requests

  • Run pnpm check and pnpm sanitize.
  • Document unsupported or degraded provider behavior.
  • Do not include credentials, private infrastructure names, real user data, or proprietary code.
  • Update the relevant package README and specification when behavior changes.

Contributions are accepted under the Apache License 2.0.