Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (44 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.01 KB
Raw

Contributing

Thank you for your interest in this project! It 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. Read the project README and CI and ISO pipeline guide.
  3. Open an issue to discuss your change before you submit a PR.

BuildStream must run through the repository's pinned container wrapper. Do not invoke bst directly on the host:

just bst show --deps all oci/tromso.bst

Validation

Run the checks for your change before you open a pull request:

# Parse all Just recipes
just --summary >/dev/null
just --evaluate >/dev/null

# Unit tests (requires bats and pytest)
just test
# Or directly: bats tests/bats/*.bats && pytest tests/pytest/ -v --tb=short

# Container linting (requires built image)
just lint

# Validate the shipping BuildStream graph in the pinned container
just bst --no-interactive show --deps all oci/tromso.bst

Changes to shell scripts, YAML, or GitHub Actions should also run ShellCheck, yamllint with .yamllint.yml, or actionlint respectively.

Pull Requests

  • Keep PRs focused — one change per PR.
  • Follow the existing code style and conventions.
  • Update docs if your change affects usage.

Questions?