mirror of
https://github.com/trailofbits/algo.git
synced 2026-08-17 21:25:50 +02:00
11e4dcae22
- Update error message to present troubleshooting and issue filing equally - Remove dead GitHub Discussions link from troubleshooting page - Simplify bug report template from 6 sections to 3 - Add config.yml to show troubleshooting link in issue chooser - Lead CONTRIBUTING.md with "We welcome bug reports!" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1.1 KiB
1.1 KiB
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.3not>=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 pre-commit hooks:
uv run pre-commit install(optional, for contributors) - For local testing, consider using Docker or a cloud provider test instance
Thanks!