cap/CONTRIBUTING.md

Contributing

Thanks for your interest in contributing to Cap!

Ways to help

• Report bugs by opening issues.
• Suggest features with clear use cases.
• Improve docs or add examples.
• Submit pull requests.

Development setup

Notes:

• You need to have the latest release version of Bun installed. For WASM, Rust is also required.

• VSCode is the recommended IDE for working on Cap.

• For writing docs, make sure to place them inside of docs/guide and make sure to update the sidebar in docs/.vitepress/config.mjs.

Run bun install in each Bun package you want to work on to install dependencies.

Guidelines

• Formatting uses Biome. Make sure there are no warnings or errors before submitting a PR.

• Keep PRs small and focused.

• We prefer conventional commits, but they are not enforced. See here for reference.

• No AI-generated code please. AI autocomplete is fine, but not fully AI code. If you submit AI-generated code without making it clear, it may be rejected.

• Type files are auto-generated from JSDoc comments

• For optimizations, please always publish a benchmark of the before/after difference before submitting a PR, ideally including your device specs. RAM/CPU usage is also appreciated.

Maintainers may reject PRs at their discretion if they don't follow these guidelines or don't align with the project's goals.