Weibo Docs

Contributing

Build, test, and send changes to Weibo.

Setup

git clone https://github.com/ASHUTOSH-SWAIN-GIT/weibo.git
cd weibo
make build

The repo has three Go modules: root (engine), control/ (control plane), and telemetry/. make targets cover all three.

Common targets

TargetWhat it does
make testUnit tests for all modules
make test-raceTests with the race detector
make ciEverything hosted CI runs
make fmt / make fmt-checkFormat / verify formatting
make vetgo vet all modules
make test-integrationOffline integration tiers
make kafka-testKafka end-to-end (needs a broker)
make fuzz-smokeRun fuzz targets briefly
make vulngovulncheck
make coverage-htmlHTML coverage report
make prod-like-upLocal Kafka, Postgres, MinIO, Prometheus, Grafana
make dashboard-demoDashboard with a live demo job

make help lists all of them.

Before a PR

  • make ci passes
  • New behaviour has tests, including recovery paths for stateful code
  • Checkpoint format changes are versioned
  • Docs updated if user-facing behaviour changed

Where things live

See Package Map and the in-repo ARCHITECTURE.md.

License

MIT.

On this page