victoriametrics/operator

0

/ 100

Documentation94
Engineering86
Health94
Go571Apache-2.01d ago
Grade a repo

Polished and well engineered. Punching above its star count.

Kubernetes operator for Victoria Metrics

Documentation

94

Contributing guide5pt78

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

86

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (api/operator/v1/cluster_types_test.go).

CI/CD14pt100

CI is configured (.github/workflows/main.yaml).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 213
    Forks
  • 187
    Releaseslatest 5y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 571
    Watchers

Responsiveness

  • 6d 3h
    Median issue response
  • 1d 1h
    Median PR merge time
  • 31
    Open issues
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yaml).
  • api
    Good: Test files detected (api/operator/v1/cluster_types_test.go).
  • cmd
  • codespell
  • config
  • docs
    Good: Security policy present.
  • hack
  • internal
    Issue: Build artifacts or local files may be committed (internal/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • test
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .trivyignore
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • kind.yaml
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • mirrord.json
  • PROJECT
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • renovate.json