Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (14 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 1.2 KB
Raw

Contributing

We welcome contributions! Feel free to open a pull request, report bugs, or share ideas through issues and discussions.

API Reference Docs

The SDK's public API summary (docs/website/content/docs/reference/api/index.mdx) is generated from TypeScript source by a pipeline under docs/website/scripts/. To regenerate it locally:

cd docs/website
npm install
npm run docs:generate-api -- 0.9.1 --latest  # writes content/docs/reference/api/index.mdx

Full workflow, CLI flags, determinism guarantees, and troubleshooting are documented in docs/website/docs-workflow.md. docs:generate-api requires bun on PATH (listed as a devDependency of docs/website).

PR Labels

CI behaviour is driven by PR labels. The verified label is the security gate that authorises every secret-bearing job to run on a PR — see docs/ci/LABELS.md for the full reference (purpose, who can apply, behaviour on push), and docs/ci/TEAMS.md for the teams that can apply it.

Changelog

Version bumps require CHANGELOG.md updates with version, date, changes by category (✨ Features, 🐛 Fixes, 🔧 Changed, etc.), and PR links.