Contributing and Local Development

[Overview](./)

This page is for developers who want to work on the PresenceKit SDK itself. If you only want to use the npm package in a website, start with Installation instead.

Repository contents

Install and run checks

From the repository root:

The build script generates the distributable JavaScript and TypeScript declaration files in dist/. check:release checks package exports, license metadata, fixed API origin, and the expected release structure.

Verify the packed npm artifact

The verification script installs the real tarball into an isolated temporary consumer project and checks framework imports, runtime behavior and TypeScript declarations.

Work with framework examples

Each example under examples/ uses the published @iconical/presence npm dependency. Once that package version is available, install dependencies and run the example from its directory:

NOTE

Before the corresponding npm version is published, those examples may not install from the public registry. Test the SDK using the local tarball procedure above, or test examples after publication. Do not confuse a missing npm release with an SDK build failure.

API compatibility

The schema in contracts/public-api-v1.schema.json documents the public REST shape. Maintain compatible response fields; breaking changes require deliberate API version planning and corresponding test updates.

Contributions and release responsibility

Before submitting a change, run the test suite, type-check, build, and inspect the applicable documentation. Do not commit credentials, personal Discord data or other secrets. npm publication is a maintainer-controlled action and is not performed by ordinary CI.

See CONTRIBUTING, the PresenceKit Source-Available License, and Privacy. The license is source-available, not an OSI-approved open-source license.