Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (48 loc) · 1021 Bytes

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 1021 Bytes

Contributing to LATTICE.DB

Thank you for your interest in contributing!

Development Setup

# Clone repository
git clone https://github.com/lattice-db/lattice.git
cd lattice

# Download dependencies
go mod download

# Run tests
go test ./...

# Run linting
gofmt -l .
go vet ./...

Code Style

  • Follow Go conventions
  • Use gofmt
  • Add tests for new features
  • Update documentation

Commit Messages

Use conventional commits:

feat: add wal segment rotation
fix: correct checksum validation
docs: update storage format doc
test: add fuzz target for wal parser

Testing

Unit Tests

go test ./...

Fuzzing

go test -fuzz=FuzzWAL ./internal/storage

Simulator

go test -v -run TestSimulator -seeds=1000 ./internal/sim

Submitting Changes

  1. Fork repository
  2. Create feature branch
  3. Make changes with tests
  4. Submit pull request

License

By contributing, you agree that your contributions will be licensed under the MIT License.