esphome/home-assistant-addon

0

/ 100

Documentation23
Engineering40
Health100
Python3231d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

ESPHome Home Assistant Add-on

Documentation

23

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.

README12pt60

README is present.

Engineering

40

Tests18pt0

No tests detected anywhere in the repository.

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

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

CI/CD14pt57

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

Reproducibility6pt92

Lockfile present (script/requirements.txt). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (script/requirements.txt).

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)
  • 151
    Forks
  • 571
    Releaseslatest 7y ago

Community

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

Responsiveness

  • 86d 6h
    Median issue response
  • 1d 19h
    Median PR merge time
  • 1
    Open issues
Repository files12 root entries
  • .claude
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • .vscode
  • esphome
  • esphome-beta
  • esphome-dev
  • script
    Good: Lockfile present (script/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (script/requirements.txt).
  • template
  • .gitignore
    Good: .gitignore present.
  • 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 little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.
  • repository.json