mirror of
https://github.com/trailofbits/algo.git
synced 2025-09-25 05:05:28 +02:00
cddb5df395
* Add comprehensive pre-commit hooks for code quality - Set up pre-commit framework with hooks for Python, YAML, Ansible, and shell - Configure ruff for Python linting and formatting - Add yamllint for YAML validation - Include ansible-lint and syntax checks - Add shellcheck for shell scripts - Create development documentation - Auto-fix trailing whitespace and file endings 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Remove redundant DEVELOPMENT.md and update CONTRIBUTING.md - Removed docs/DEVELOPMENT.md as it was redundant with existing documentation - Added pre-commit hooks setup instruction to CONTRIBUTING.md for contributors - Consolidated development guidance into a single location 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
23 lines
1.2 KiB
Markdown
23 lines
1.2 KiB
Markdown
### Filing New Issues
|
|
|
|
* Check that your issue is not already described in the [FAQ](docs/faq.md), [troubleshooting](docs/troubleshooting.md) docs, or an [existing issue](https://github.com/trailofbits/algo/issues)
|
|
* 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 pre-commit hooks: `uv run pre-commit install` (optional, for contributors)
|
|
* For local testing, consider using Docker or a cloud provider test instance
|
|
|
|
Thanks!
|