victoriametrics/operator
Grade a repo

90

/ 100

GradeA

Polished and well engineered. Punching above its star count.

Top 12% of 5,156 graded repos

Kubernetes operator for Victoria Metrics

Documentation94
Engineering86
Health94
Go572Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  2. 2
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  3. 3
    Issue and PR templates6pt

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

  4. 4
    Reproducibility6pt

    Remove replace directives before publishing if they point to local paths.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

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

  • 85 / 291
    Commits (30d / 90d)
  • 213
    Forks
  • 187
    Releaseslatest 6y ago

Community

  • 62% - Fair
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 572
    Watchers

Responsiveness

  • 6d 3h
    Median issue response
  • 1d 1h
    Median PR merge time
  • 33
    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
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/victoriametrics/operator)](https://www.repo-grade.com/report/victoriametrics/operator)

More graded Go repos