Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (59 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

82 lines (59 loc) · 2.43 KB
Raw

Contributing to supervision-js

Thanks for helping improve supervision-js. We welcome bug reports, documentation corrections, examples, performance investigations, and focused code contributions.

Before You Start

  • Search existing issues and pull requests before opening a new one.
  • Keep browser renderer changes aligned with the session-first public API.
  • Do not expose PixiJS, Mediabunny, worker, or prepared-artifact internals as public API without a concrete consumer need.
  • Treat React Native as experimental and keep it independent of the browser package.

For project boundaries and commands, read docs/internal/agent-guidance.md.

Contributions that add visualization recipes or annotator-style facades should also follow the annotator use-case roadmap, including its one-annotator-per-PR and frozen-fixture requirements.

Local Development

Use Node.js 20.19 or newer.

npm install
npm run dev

Useful checks:

npm run format:check
npm run lint
npm run typecheck
npm run test
npm run verify

npm run verify is the full local validation suite used by CI. For package changes, also run:

npm run package:tarball
npm run package:tarball:smoke

The tarball smoke test verifies an external consumer; a monorepo build alone is not enough to prove package portability.

Pull Requests

Keep each pull request focused and include:

  • a concise explanation of the user or maintainer impact;
  • tests for behavior changes, or an explanation of why tests are unnecessary;
  • documentation updates for public API or workflow changes;
  • screenshots or a short recording for visual demo/docs changes;
  • performance evidence when changing a renderer hot path.

Run the relevant checks before requesting review. Maintainers may ask to split unrelated refactors from behavioral changes so they can be reviewed safely.

Documentation And Examples

Public API changes must update the corresponding facade under docs/public/api/ and the relevant guide or recipe. Keep copyable examples browser-safe and avoid requiring a Roboflow API key unless the guide explicitly describes that integration.

Reporting Security Issues

Do not open a public issue for a suspected vulnerability. See SECURITY.md for the private reporting path.

License

By contributing, you agree that your contributions are licensed under the MIT License.