🧠the-brain

Contributing

How to contribute to the-brain

Philosophy

  • All code, comments, docs in English. CLI messages may be localized.
  • No emojis in commits, issues, PRs, or code (except README branding).
  • TDD with >80% coverage.
  • Pluggable architecture: core is an empty data bus.

Setup

git clone https://github.com/oskarschachta/the-brain.git
cd the-brain
bun install
bun run build
bun test

Project Structure

See Project Structure for the monorepo layout.

Before Submitting

bun test && bun run lint    # All green
bun test --coverage         # >80% line coverage
cd apps/docs && bun run build  # Docs build clean

Commit Style

<type>: <description>

feat: add Windsurf harvester
fix: correct SPM threshold calculation
docs: update hook system reference

Types: feat, fix, docs, chore, refactor, test.

Pull Requests

  • One concern per PR
  • New features need tests
  • Breaking changes need migration guide

See Also

On this page