Skip to main content

Contributing

Thanks for your interest in this project! This project is part of the TunaOS ecosystem.

Contribute compute — no code needed​

Donate time with your AI CLI.

Your machine runs one task at a time using your signed-in AI coding CLI. The relay alternates between eligible School (OS) and Reef (apps) hives after each task. If one hive has no work, the other can continue.

The guide covers prerequisites, verified just setup, credentials, provider costs, and how to stop with Ctrl+C. Your subscription quota or API charges apply. Never post account credentials or API keys in issues or pull requests.

Getting Started​

  1. Fork the repo and clone it locally.
  2. Install Go 1.26.7 or later (see the go directive in go.mod) and just. Install Podman if you want to use the container-based recipes.
  3. Open an issue to discuss your change before you submit a PR.

Build and validate​

Build both the standard and plus variants:

just build

Run the local test suite and the race-enabled configuration used in CI:

go test ./...
go test -tags extra -race ./...

Run the lint check that CI runs. You need golangci-lint version 2, because .golangci.yml uses the version 2 format. To install it, see the golangci-lint install guide. Then run this command from the repository root:

golangci-lint run

Do not use just lint for this check. The development container does not include golangci-lint, so the recipe skips the check and exits with 0.

For the containerized integration suite, run:

just test

If a change affects commands or flags, regenerate the command reference from the extra build. The extra build includes both published binaries. Include the new Markdown in your PR:

go build -tags extra -o bluefin-cli .
./bluefin-cli docs --dest ./docs/commands

Run just --list to see the remaining development and inspection recipes.

Pull Requests​

  • Keep PRs focused — one change per PR.
  • Follow the existing code style and conventions.
  • Update docs if your change affects usage.
  • Run gofmt (or just fmt) on changed Go files.
  • Confirm go mod tidy -diff is clean when dependencies change.

Questions?​