Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.1 KB

File metadata and controls

23 lines (17 loc) · 1.1 KB

Filing New Issues

  • We welcome bug reports! Before filing, a quick check of the FAQ or troubleshooting docs might have your answer
  • Algo automatically installs dependencies with uv - no manual setup required
  • We support modern clients: macOS 12+, iOS 15+, Windows 11+, Ubuntu 22.04+, etc.
  • Supported cloud providers: DigitalOcean, AWS, Azure, GCP, Vultr, Hetzner, Linode, OpenStack, CloudStack
  • If you need to file a new issue, fill out any relevant fields in the Issue Template

Pull Requests

  • Run the full linter suite: ./scripts/lint.sh
  • Test your changes on multiple platforms when possible
  • Use conventional commit messages that clearly describe your changes
  • Pin dependency versions rather than using ranges (e.g., ==1.2.3 not >=1.2.0)

Development Setup

  • Clone the repository: git clone https://github.com/trailofbits/algo.git
  • Run Algo: ./algo (dependencies installed automatically via uv)
  • Install git hooks: prek install (optional, for contributors)
  • For local testing, consider using Docker or a cloud provider test instance

Thanks!