Contributing / Contributing
Development Setup
Install development tools, configure pre-commit hooks, and build Aurora from source.
Browse docs
Development Setup
Prerequisites
Install all required development tools in one step:
text
make install-tools
This installs:
- golangci-lint v2 — Required for
make lint - pre-commit — Required for git hook setup
After installing tools, set up the pre-commit hooks:
text
pre-commit install
Building
text
go build -o aurora ./apps/aurora # Production build
go build -race -o aurora ./apps/aurora # With race detection
Testing
text
make test # Go unit tests
make test-race # With race detection and coverage
make test-dashboard # Dashboard JavaScript unit tests
make test-e2e # End-to-end tests (in-process, no Docker)
make test-all # All tests
Linting
text
make lint # Check code quality
make lint-fix # Auto-fix issues
Release Process
Releases are auto-generated from merged PRs, categorized by labels and PR titles.
- PR titles must use Conventional Commit format
- Use Squash and merge so each PR lands as one commit
- Release labels auto-applied from PR title type
Repomix
Compress the repository for LLMs:
text
repomix -i "./*.md,./**/*_test.go,./tests/,./**/*.md,./.claude/,./data/,./docs/,./helm/" --style=markdown --remove-comments