Contributing on aibox

Maintenance

Mon, 01 Jan 0001 00:00:00 +0000

Maintenance

Internal procedures for building, testing, documenting, and releasing aibox. The canonical step-by-step release note remains in context/notes/; this page is the public contributor summary.

Development Checks

cd cli && cargo fmt -- --check
cd cli && cargo clippy --all-targets -- -D warnings
cd cli && cargo test

The helper script wraps the same checks:

./scripts/maintain.sh test

Documentation Site

The public docs live in docs-site/ and use Hugo with the Docsy theme.

git submodule update --init --recursive docs-site/themes/docsy
npm --prefix docs-site ci
./scripts/maintain.sh docs-serve
./scripts/build-docs.sh

./scripts/build-docs.sh is the local verification build. It writes the static site to docs-site/public/ and prints Hugo render warnings.

E2E Test Catalogue

Mon, 01 Jan 0001 00:00:00 +0000

E2E Test Catalogue

aibox deliberately has no container-runtime bridge from its development container. Tests are placed according to the product behavior they prove, not according to the historical runner that happened to execute them.

Execution surfaces

Surface	Where it runs	Contracts
Local	Development container, unique temporary directories	CLI parsing, init/apply, generated files, preservation, configuration, migrations, mocked runtime behavior, terminal rendering
Local visual	Development container, per-test tmux socket	Real panes, layouts, keybindings, Yazi/Vim interaction, asciinema output
Release host	Owner-controlled macOS gate	Native Darwin binaries and genuine candidate-image build/start/probe/down behavior

Run the complete local suite with cd cli && cargo test. The compatibility feature e2e no longer grants access to another machine or runtime. Opt-in visual matrices run with:

Version-line porting

Mon, 01 Jan 0001 00:00:00 +0000

Version-line porting

aibox maintains the v0.x and v1.x lines in parallel. A fix landing on either line must be reconciled with the other line when applicable.

The release gate compares both maintained branches after the recorded enforcement baselines in .github/version-line-port-baselines.toml. Every non-merge source commit must have a matching port on the target line or an explicit not-applicable disposition. This derives obligations from Git history, so it does not depend on labels, manually created issues, or workflow tokens.