Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (35 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 1.65 KB
Raw

Contributing

Thanks for considering a contribution. chkit is a young project — bug reports, docs PRs, and small fixes are especially welcome.

Prerequisites

  • Bun 1.3.5+
  • Node.js 20+

Setup

git clone https://github.com/obsessiondb/chkit
cd chkit
bun install

Development

bun run typecheck    # type-check all packages
bun run lint         # lint all packages
bun run test         # run unit tests
bun run build        # build all packages

E2E tests run against a live ClickHouse instance and require CLICKHOUSE_HOST (or CLICKHOUSE_URL) and CLICKHOUSE_PASSWORD to be set. See CLAUDE.md for the full list.

Pull request CI starts its own ClickHouse service and seeds the test fixtures, including for contributions from forks. After changes land on main, CI also runs the test suite against ObsessionDB before deployment.

Pull requests

  • Branch off main, PR back to main.

  • Keep PRs focused on one logical change.

  • Run a changeset for any user-facing package change:

    bun run changeset

  • typecheck, lint, test, and build must all pass.

  • Commit messages are free-form. Changesets capture the user-facing narrative.

Plugins

Plugins live in packages/plugin-*. The official plugins are the reference — codegen, pull, backfill, and obsessiondb each show a different hook surface. The simplest starting point is to copy one and adapt it.

Reporting issues

License

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