Contributing

Prerequisites

Bun v1.x

Setup

bun install
cp config.example.json config.json
# Edit config.json — set at least one notifier webhook URL

Running locally

bun run dev        # hot-reload dev server
bun run build      # compile self-contained binaries → ./dist

Tests

bun test           # run tests with coverage
bun run lint       # lint with Biome
bun run lint:fix   # auto-fix lint issues
bun run check      # Run all type checks

Other scripts

bun run gen:schema    # regenerate schema/config.schema.json
bun run gen:docs      # regenerate docs/env.md and docs/config.md
bun run gen           # Run all generators

Adding a notifier

Create src/lib/notifiers/<name>.ts — export a Zod schema and a class extending AbstractNotifier
Add the schema import and union entry in src/config.ts
Add an instantiation branch in src/lib/notifiers/index.ts
Add corresponding BABA_* env vars in src/lib/env.ts

Release process

Fork the repository
Create a new branch for your changes
Make your changes and commit them
Push your changes to your fork
Create a pull request against the main repository

Baba

Configuration Reference

This guide lives in the project repo: edit it there, and this page follows within a day.