Skip to content

Roadmap And Contributing

karurikwao edited this page Jul 5, 2026 · 1 revision

Roadmap And Contributing

Roadmap

Current roadmap direction:

  • V0.1.x: harden fixtures, expand provider-specific log distillers, improve package-manager install paths, and continue MCP compatibility validation.
  • V0.2.0: versioned GitHub Action tag, published Homebrew tap, shell completions, and richer release binaries.
  • V0.3.0: published Python package and deeper LangChain/LlamaIndex adapters.
  • V0.4.0: AST-aware code compression behind explicit flags.

Good First Contributions

Useful starter work:

  • add real-world GitHub Actions fixtures from public failing workflows
  • add malformed HTML fixtures from docs sites and browser exports
  • add shell completions for Bash, Zsh, Fish, and PowerShell
  • turn Homebrew notes into a published tap
  • validate more MCP clients
  • add provider fixtures for Docker Buildx, pytest, cargo, and Playwright logs

Contribution Rules

Before opening a PR:

cargo fmt --all -- --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace --all-features --locked

On Windows:

.\scripts\check.ps1

Benchmark Claims

Do not add new README or website proof numbers unless they are backed by:

  • a committed fixture
  • measured token counts
  • must-keep checks
  • must-remove checks where applicable
  • regenerated benchmark output

Safety Contributions

Safety-related changes should be conservative. When changing scanner, ignore, or redaction behavior, include tests for:

  • sensitive path skips
  • explicit opt-in behavior
  • redaction warnings
  • generated file skips
  • .gitignore and .ctxcleanignore behavior

Clone this wiki locally