Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (66 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

90 lines (66 loc) · 2.94 KB

Contributing to THOR

Thank you for your interest in contributing to THOR! This project aims to be the best open-source control center for NVIDIA Jetson devices on macOS.

Getting Started

git clone https://github.com/RobotFlow-Labs/thorapp.git
cd thorapp
make build
make test-unit
make test        # Requires Docker Desktop for the Jetson simulators
make run          # Launch the app

Development Setup

  • macOS 14+ (Sonoma) on Apple Silicon
  • Swift 6.2+ — xcode-select --install
  • Docker Desktop — required for the full simulator-backed test suite

How to Contribute

Bug Reports

Open an issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • macOS version, Swift version
  • Relevant logs or screenshots

Feature Requests

Open an issue with the enhancement label describing:

  • The use case
  • Which Jetson model(s) it applies to
  • How it would work in the UI and/or CLI

Pull Requests

  1. Fork the repo and create your branch from main
  2. Write code following existing patterns
  3. Add tests for new endpoints and features
  4. Ensure make test-unit passes
  5. Ensure make test passes when Docker Desktop is running
  6. Ensure swift build has 0 warnings
  7. Update the README and relevant docs if you change install, update, or release behavior
  8. Submit a PR with a clear description

Repo Layout

  • Public docs live under docs/:
    • docs/setup/ for runbooks
    • docs/product/ for PRDs
    • docs/release/ for packaging and release operations
  • Script entrypoints are grouped under Scripts/dev, Scripts/release, Scripts/setup, and Scripts/jetson-thor.
  • Legacy root script paths are kept as compatibility wrappers, but new automation should use the grouped paths.

Code Style

  • Swift: Follow Apple API Design Guidelines. Use @Observable, @MainActor, structured concurrency.
  • Python: Follow PEP 8. Use type hints where practical.
  • Views: One view per file. Use GroupBox for cards, system colors, 8pt spacing grid.
  • Tests: Use Swift Testing framework (#expect, #require). Integration coverage runs against the real Docker sims.
  • No mocks: All integration tests hit the real Docker Jetson simulator.

Adding a New Agent Endpoint

  1. Create or modify a router in Agent/routers/
  2. Add the response model in Sources/THORShared/Models/
  3. Add the client method in Sources/THORShared/SSH/AgentClient.swift
  4. Add a SwiftUI view or panel
  5. Add a thorctl command in Sources/THORctl/main.swift
  6. Add integration tests in Tests/
  7. Update the Docker simulator if needed

Packaging

For a public-release style smoke test:

make dist

This produces app and CLI artifacts in dist/. If you are validating a release path locally, run make test-unit first and make test when Docker Desktop is available.

License

By contributing, you agree that your contributions will be licensed under the MIT License.