CONTRIBUTING.md

Contributing to the Zerobus TypeScript SDK

Please read the top-level CONTRIBUTING.md first for general contribution guidelines, pull request process, and commit requirements.

This document covers TypeScript-specific development setup and workflow.

Development Setup

Prerequisites

• Git
• Node.js >= 16 - Download Node.js
• Rust toolchain (1.70+) - Install Rust

Setting Up Your Development Environment

1. Clone the repository:

   git clone https://github.com/databricks/zerobus-sdk.git
   cd zerobus-sdk/ts

2. Install dependencies:

   npm install

3. Build the project:

   npm run build:debug

   This will compile the Rust code into a native Node.js addon (.node file) for your platform.

4. Run tests:

   npm test

Building

Debug Build

Faster compilation, includes debug symbols:

npm run build:debug

Release Build

Optimized for production:

npm run build

Cross-Platform Builds

Build for specific targets:

npm run build -- --target x86_64-apple-darwin
npm run build -- --target x86_64-unknown-linux-gnu
npm run build -- --target x86_64-pc-windows-msvc

Testing

# Run all tests
npm test

# Unit tests only
npm run test:unit

# Integration tests
npm run test:integration

Code Style

Rust Code

Follow standard Rust formatting:

cargo fmt --all
cargo clippy --all-targets --all-features

TypeScript/JavaScript

Follow standard TypeScript conventions:

• Use camelCase for variables and functions
• Use PascalCase for types and classes
• Prefer const over let
• Use async/await over Promise chains

Continuous Integration

All pull requests must pass CI checks:

• build: Cross-platform builds for Linux (x86_64, aarch64) and Windows (x64)
• test: Unit tests on Node.js 16, 18, and 20 across Linux and Windows runners