Skip to content

CLAUDE.md

Latest commit

 

History

History
52 lines (35 loc) · 2.48 KB

CLAUDE.md

File metadata and controls

52 lines (35 loc) · 2.48 KB

CLAUDE.md

Project Overview

Runi is a curated Rust foundation library collection. Core value: provide essential utilities while keeping dependencies minimal. Prefer the standard library and small, well-maintained crates; reject additions that pull in heavy or duplicative dependency trees.

Sister project: wvlet/uni is the Scala counterpart with the same philosophy — useful as a reference for module scope, naming, and API shape.

Workspace

Crates (unified version via workspace.package.version):

  • runi-core — core types
  • runi-log — structured logging
  • runi-test — test utilities
  • runi-cli — terminal styling and CLI launcher (with derive feature)
  • runi-cli-macros — proc-macros for runi-cli's #[derive(Command)]

API design

Optimize for the smallest mental model the caller needs before they can use a module. Provide sensible defaults, expose a narrow public surface, and let advanced configuration live behind builders or feature flags rather than required arguments. A new user should be able to reach for the obvious entry point and have it work.

Commands

cargo build --workspace --all-targets   # Build everything
cargo test --workspace                  # Run tests
cargo fmt --all                         # Format Rust (CI checks --check)
taplo fmt                               # Format TOML (CI checks --check)
cargo clippy --workspace --all-targets -- -D warnings
mdbook serve docs                       # Local docs preview

Git workflow

  • Never push directly to main. All changes require PRs.
  • Create the branch first: git switch -c <prefix>/<topic>.
  • Save plan documents to plans/YYYY-MM-DD-<topic>.md.
  • Use gh for PR management.
  • Never enable auto-merge without explicit user approval. When approved: gh pr merge --squash --auto.

Branch prefixes

breaking/, feature/, fix/, chore/, test/, deps/, docs/. These drive PR labels and release-note grouping; see .github/labeler.yml and .github/release.yml.

Release process

Tag-driven, automated by .github/workflows/release.yml and release-note.yml:

  1. Bump [workspace.package].version (and matching workspace.dependencies versions) in the root Cargo.toml; merge the bump PR.
  2. git tag vX.Y.Z origin/main && git push origin vX.Y.Z.
  3. The release workflow publishes all five crates to crates.io in dependency order; the release-note workflow creates a GitHub release with auto-generated notes grouped by label.