victoriametrics/victorialogs
Grade a repo

0

/ 100

GradeB

A well-known project done right. Strong docs and solid engineering throughout.

Top 20% of 5,156 graded repos

Fast and easy to use database for logs, which can efficiently handle terabytes of logs

Documentation69
Engineering92
Health100
Go1,967Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

13 to address
  1. 1
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  4. 4
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## headings.

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

69

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt52

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

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

README12pt78

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

92

CI/CD14pt72

CI is configured (.github/workflows/build.yml).

Tests18pt100

Test files detected (app/vlagent/filecollector/processor_test.go).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 145
    Forks
  • 34
    Releaseslatest 11mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 1,967
    Watchers

Responsiveness

  • 1d 10h
    Median issue response
  • 2d
    Median PR merge time
  • 226
    Open issues
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot covers 6 ecosystems (github-actions, gomod, bundler, gomod, docker, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • app
    Good: Test files detected (app/vlagent/filecollector/processor_test.go).
    Good: Environment pinned via app/victoria-logs/multiarch/Dockerfile.
  • apptest
  • benchmarks
  • codespell
  • dashboards
  • deployment
  • docs
  • lib
  • package
  • vendor
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .wwhrd.yml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • README.md
    Good: README is present.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.
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/victorialogs)](https://www.repo-grade.com/report/victoriametrics/victorialogs)

More graded Go repos