kubernetes-sigs/sig-storage-local-static-provisioner
Grade a repo

92

/ 100

GradeA

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

Top 10% of 5,156 graded repos

Static provisioner of local volumes

Documentation87
Engineering95
Health92
Go1,203Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

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

  3. 3
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  4. 4
    Install and run instructions9pt

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

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

87

Contributing guide5pt70

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.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

95

CI/CD14pt85

CI is configured (.github/workflows/helm-chart-lint.yml).

Reproducibility6pt97

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

Tests18pt100

Test files detected (cmd/utils/update-helm-values-pre-v2.2.0/main_test.go).

Linting and formatting5pt100

Formatting enforced (vendor/github.com/Masterminds/semver/v3/.golangci.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

92

Dependency manifest6pt75

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)
  • 349
    Forks
  • 12
    Releaseslatest 2y ago

Community

  • 87% - Good
    Community health
  • 4 bus factor
    authors own >50% of commits
  • 1,203
    Watchers

Responsiveness

  • 18h
    Median issue response
  • 1d 11h
    Median PR merge time
  • 13
    Open issues
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/helm-chart-lint.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • cmd
    Good: Test files detected (cmd/utils/update-helm-values-pre-v2.2.0/main_test.go).
    Good: Environment pinned via cmd/node-cleanup/Dockerfile.
  • deployment
  • docs
  • examples
  • hack
  • helm
  • pkg
  • test
  • third_party
  • vendor
    Good: Code of conduct present.
    Good: Formatting enforced (vendor/github.com/Masterminds/semver/v3/.golangci.yml).
    Good: Security policy present.
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
  • cloudbuild.yaml
  • code-of-conduct.md
  • 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.
    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.
  • KNOWN_ISSUES.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • OWNERS
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README documents how to run the project.
  • RELEASE.md
  • SECURITY_CONTACTS
  • TODO.md
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/kubernetes-sigs/sig-storage-local-static-provisioner)](https://www.repo-grade.com/report/kubernetes-sigs/sig-storage-local-static-provisioner)

More graded Go repos