Skip to content

Contributing

Peter Mueller edited this page Apr 3, 2026 · 1 revision

Contributing to Vespasian

Contributions to Vespasian are welcome.

Development Setup

Prerequisites

  • Go 1.24+
  • golangci-lint

Build and Test

git clone https://github.com/praetorian-inc/vespasian.git
cd vespasian
make build       # Build the binary to bin/vespasian
make test        # Run tests with race detection
make lint        # Run golangci-lint (gocritic, misspell, revive)
make check       # Run all checks (fmt, vet, lint, test)
make coverage    # Generate coverage report
make deps        # Download and tidy modules
make clean       # Remove build artifacts

How to Contribute

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Commit your changes (git commit -am 'Add my feature')
  4. Push to the branch (git push origin feature/my-feature)
  5. Open a Pull Request

Please ensure all CI checks pass before requesting review.

Clone this wiki locally