Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (30 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.28 KB
Raw

Contributing

Thanks for your interest in improving these packages.

Ground rules

  • Be respectful — see CODE_OF_CONDUCT.md.
  • Report security issues privately — see SECURITY.md. Never open a public issue for a vulnerability.
  • By submitting a contribution you agree it is licensed under the repository's Apache License 2.0.

Filing issues

  • Search existing issues first.
  • For bugs: include a minimal reproduction, the package + version, your runtime (Node version, browser), and expected vs. actual behavior.
  • For features: describe the use case before the implementation.

Pull requests

  1. Fork and branch from main.
  2. Keep changes focused — one concern per PR.
  3. Match the surrounding code style. Formatting and linting use Biome (pnpm biome check --write).
  4. Add or update tests for behavior changes.
  5. Make sure pnpm build, pnpm test, and typecheck pass.
  6. Write a clear PR description: what changed and why.

Local development

pnpm install
pnpm build          # build all packages
pnpm test           # run the test suites

Commit sign-off

Contributions are accepted under the Developer Certificate of Origin. Sign your commits with git commit -s.