Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.33 KB
Raw

Contributing

Design Goals

Chibi aims to be a minimal, secure core with extensibility through plugins.

  • Core binary: Small, stable, few dependencies. Changes here need strong justification.
  • Plugins: Where features live. Most contributions should be plugins, not core changes.

Guidelines

  • see justfile for workflow
  • cargo fmt your patches
  • don't make clippy sad
  • test-driven development appreciated
  • documentation bugs are serious bugs
  • be nice to the chibis

Plugins vs Core

Before adding code to the Rust binary, ask: can this be a plugin?

Plugins can:

  • Add new capabilities for the LLM (tool calls)
  • Hook into lifecycle events (pre_message, post_tool, etc.)
  • Inject content into system prompts
  • Intercept and modify behavior

The core handles: API communication, context management, plugin loading, streaming.

Stable plugins may eventually be incorporated in the Rust binary.

CLI Conventions

Commands use flags (-l, -s, -C). Bare words are prompts.

chibi -l              # command: list contexts
chibi list            # prompt: sends "list" to LLM

Tests in src/cli.rs codify this behavior.

Testing

cargo test            # all tests
cargo test cli        # CLI parsing tests

Plugins Repo

For plugin contributions, see chibi-plugins.