Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 845 Bytes

File metadata and controls

53 lines (36 loc) · 845 Bytes

Contributing

Thanks for taking the time to contribute.

Development Setup

  1. Copy the example environment file:
cp .env.example .env
  1. Start the local dependencies:
docker compose -f docker-compose.local.yml up -d
  1. Run the backend locally:
set -a
source .env
set +a
go run ./cmd/server

Testing

Run the backend test suite before opening a pull request:

go test ./cmd/... ./internal/...

Pull Requests

  • Keep changes scoped and focused.
  • Prefer small, reviewable commits.
  • Update README.md, .env.example, or CHANGELOG.md when behavior or setup changes.
  • Add or update tests for code changes that affect behavior.

Commit Style

Conventional-style commit messages are preferred:

  • feat: ...
  • fix: ...
  • perf: ...
  • docs: ...
  • chore: ...
  • ci: ...