k3s-io/k3s
Grade a repo

95

/ 100

GradeA

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Top 6% of 5,156 graded repos

Lightweight Kubernetes

Documentation91
Engineering96
Health100
Go33,375Apache-2.01mo ago

Outstanding. A score of 95/100 puts this repo in a very small tier of truly well-engineered projects.

Top fixes

Highest-impact changes first, ranked by point weight

7 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

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

  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

91

Contributing guide5pt77

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt93

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

96

CI/CD14pt85

CI is configured (.github/workflows/build-k3s.yaml).

Tests18pt100

Test files detected (cmd/k3s/main_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

  • 46 / 126
    Commits (30d / 90d)
  • 2,678
    Forks
  • 1000
    Releaseslatest 7y ago

Community

  • 87% - Good
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 33,375
    Watchers

Responsiveness

  • 12h
    Median issue response
  • 2h
    Median PR merge time
  • 92
    Open issues
Repository files39 root entries
  • .agents
  • .github
    Good: CI is configured (.github/workflows/build-k3s.yaml).
    Good: Dependabot covers 7 ecosystems (github-actions, docker, docker, docker, docker, docker, docker). Dependencies stay current.
    Good: Issue or PR templates present.
    Good: Security policy present.
  • cmd
    Good: Test files detected (cmd/k3s/main_test.go).
  • contrib
  • docs
  • manifests
  • package
  • pkg
  • scripts
  • tests
  • updatecli
  • .clomonitor.yml
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • ADOPTERS.md
  • BUILDING.md
  • channel.yaml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODEOWNERS
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • DCO
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.manifest
  • Dockerfile.test
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • GOVERNANCE.md
  • install.sh
  • install.sh.sha256sum
  • k3s-rootless.service
  • k3s.service
  • LICENSE
    Good: Licensed under Apache-2.0.
  • main.go
  • MAINTAINERS
  • 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.
    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.
  • ROADMAP.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/k3s-io/k3s)](https://www.repo-grade.com/report/k3s-io/k3s)

More graded Go repos