Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
9 lines (6 loc) · 784 Bytes

CONTRIBUTING.md

File metadata and controls

9 lines (6 loc) · 784 Bytes
Raw

Contributing to subflux

The shared rules for commits, releases, synced files and checks apply here.

Rules

  • Every provider builds its HTTP client with provider.NewHTTPClient or provider.NewHTTPClientNoClientTimeout. A client built any other way skips the SSRF checks, the redirect policy and the response size cap, and no test notices.
  • Rename or relabel a metric in the same commit as the alert rules in alerts/promql.yaml that read it. A rule over a series subflux no longer exports stays silent, and TestAlertRulesNameExportedSeries fails on it.
  • Write a file the server keeps with github.com/cplieger/go/filesafe, never os.WriteFile. A plain write can leave a half-written file after a crash.