auricom/home-ops

0

/ 100

Documentation26
Engineering28
Health68
Shell2061d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

My home Kubernetes (talos) cluster managed by GitOps (Flux2) and serviced with RenovateBot

Documentation

26

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt68

README is present.

Engineering

28

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt57

CI is configured (.github/workflows/flux-local.yaml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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)
  • 8
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • 24h
    Median PR merge time
  • 38
    Open issues
Repository files19 root entries
  • .archive
  • .github
    Good: CI is configured (.github/workflows/flux-local.yaml).
  • .just
  • .vscode
  • ansible
  • docs
  • kubernetes
  • scripts
  • tools
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .justfile
  • .pre-commit-config.yaml
  • .sops.yaml
  • AGENTS.md
  • CLAUDE.md
  • mise.toml
    Good: Environment pinned via mise.toml.
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.