Contributing to Klag

September 21, 2026 · View on GitHub

Thanks for helping. Full guide: klag.dev/development/contributing.

Quick start

  1. Pick an issue before opening a PR — prefer ones labeled good first issue or hacktoberfest. Comment on the issue to claim it.
  2. Fork, branch from main, make a focused change.
  3. Requires Java 21. Run: 
    ./gradlew test
    Helm chart changes also need ./scripts/test-helm-chart.sh. Website/docs changes: cd website && npm ci && npm test && npm run check.
  4. Open a pull request that links the issue.

Quality bar

  • Prefer a linked issue and tests for behavior changes.
  • Drive-by typo / whitespace-only PRs will be closed unless they fix something substantive or were agreed on an issue.
  • Metric names and tags are a public API — see the contributing guide when adding or retagging metrics.

Hacktoberfest

Look for the hacktoberfest label and the pinned contributor-board issue. Issues are curated; unsolicited spam PRs will not be merged.