Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.53 KB
Raw

Contributing

Thanks for your interest in docker-exporter! Contributions are welcome.

Development

docker-exporter is a standard Go module (Go 1.26+). No code generation or extra tooling is required.

go build ./...      # build
go vet ./...        # vet
go test ./...       # unit tests

Formatting is enforced in CI — run gofmt -w . before committing.

You can run the exporter locally against your Docker socket:

go run . --log-level debug
curl -fsS localhost:8080/metrics

Pull requests

  • Keep changes focused; one logical change per PR.
  • Use Conventional Commits for commit messages (feat:, fix:, docs:, refactor:, ci: …).
  • Add or update tests for behavioural changes.
  • Make sure gofmt, go vet, and go test ./... pass.

Reporting issues

Use the issue templates. For security-sensitive reports, see SECURITY.md.

Releases

Releases are automated — no manual tagging:

  • release-please watches main and, from the Conventional Commit history, maintains a "release PR" that bumps the version and updates CHANGELOG.md. Merging it creates the tag and the GitHub release.
  • goreleaser then builds the binaries and the multi-arch (amd64/arm64) image, pushes it to ghcr.io/davidborzek/docker-exporter, and attaches archives + checksums to the release — in the same workflow run (hanging off release-please's output, so no PAT is needed).