Skip to main content
Contributions are welcome! Here’s how to get started.

​
Development Setup

1

Fork and clone

Fork the repo on GitHub, then clone your fork:
git clone https://github.com/<your-username>/Harbor.git
cd Harbor
2

Install dependencies

cd ui && npm ci && cd ..
3

Run the app

cd crates/harbor-desktop && cargo tauri dev
Or build just the CLI:
cargo build -p harbor-cli

​
Making Changes

  1. Create a branch from main
  2. Keep changes focused and minimal
  3. Run cargo build --workspace to verify your changes compile
  4. Submit a pull request with a description of what you changed and why

​
Guidelines

  • Keep PRs focused on a single change
  • Follow existing code style and patterns
  • Write descriptive commit messages
  • If adding a new CLI command, follow the nautical naming theme
  • If modifying connector behavior, test against the affected host config format

​
Reporting Bugs

Open an issue with:
  • Steps to reproduce
  • Expected vs actual behavior
  • Your OS and Harbor version

​
Suggesting Features

Open a discussion or feature request describing:
  • The problem you’re trying to solve
  • How you’d like it to work
  • Any alternatives you’ve considered