Contributing / Contributing

Contributing

How to contribute to Aurora — development setup, testing, and release process.

Browse docs

Contributing to Aurora

Aurora is open source and welcomes contributions. This guide covers the development workflow, testing strategy, and release process.

Quick Start

text

# Clone the repository git clone https://github.com/aurorahq/aurora.git cd Aurora
# Install development tools make install-tools
# Set up pre-commit hooks pre-commit install
# Build go build -o aurora ./apps/aurora
# Run tests make test

Project Structure

cmd/ — Entry points (aurora, bench-server)
internal/ — All core logic
server/ — HTTP server, middleware, handlers
core/ — Domain types, canonical JSON codecs
providers/ — Provider registry and implementations
gateway/ — Request orchestration
httpclient/ — HTTP client configuration
helm/ — Kubernetes Helm chart
ui/ — Dashboard frontend
docs/ — Documentation source

Development Flow

Fork the repository
Create a feature branch
Make your changes
Run tests: make test 5. Run linter: make lint 6. Open a pull request

Commit Format

Use Conventional Commits:

type(scope): short summary
Allowed types: feat, fix, perf, docs, refactor, test, build, ci, chore, revert

See Development Setup for detailed setup, Testing Strategy for test guidelines, and Architecture for codebase architecture docs.

Contributing to Aurora

Aurora is open source and welcomes contributions. This guide covers the development workflow, testing strategy, and release process.

Quick Start

text

# Clone the repository git clone https://github.com/aurorahq/aurora.git cd Aurora
# Install development tools make install-tools
# Set up pre-commit hooks pre-commit install
# Build go build -o aurora ./apps/aurora
# Run tests make test

Project Structure

cmd/ — Entry points (aurora, bench-server)

internal/ — All core logic

server/ — HTTP server, middleware, handlers

core/ — Domain types, canonical JSON codecs

providers/ — Provider registry and implementations

gateway/ — Request orchestration

httpclient/ — HTTP client configuration

helm/ — Kubernetes Helm chart

ui/ — Dashboard frontend

docs/ — Documentation source

Development Flow

Fork the repository

Create a feature branch

Make your changes

Run tests: make test 5. Run linter: make lint 6. Open a pull request

Commit Format

type(scope): short summary Allowed types: feat, fix, perf, docs, refactor, test, build, ci, chore, revert

See Development Setup for detailed setup, Testing Strategy for test guidelines, and Architecture for codebase architecture docs.