0
/ 100
Getting noticed, but rough fundamentals could turn visitors away.
ESPHome Home Assistant Add-on
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (75).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add a lint step to catch style issues automatically.
- 4CI/CD14pt
Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
23
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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.
README is present.
Engineering
40
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
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 is configured (.github/workflows/lint.yml).
Lockfile present (script/requirements.txt). Installs are reproducible.
Issue or PR templates present.
Project health
100
Dependency manifest found (script/requirements.txt).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 151Forks
- 571Releaseslatest 7y ago
Community
- -Community health
- -authors own >50% of commits
- 323Watchers
Responsiveness
- 86d 6hMedian issue response
- 1d 19hMedian PR merge time
- 1Open issues
Repository files12 root entries
- .claude
- .devcontainerGood: Environment pinned via .devcontainer/Dockerfile.
- .githubGood: 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
- scriptGood: Lockfile present (script/requirements.txt). Installs are reproducible.Good: Dependency manifest found (script/requirements.txt).
- template
- .gitignoreGood: .gitignore present.
- README.mdGood: 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
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/esphome/home-assistant-addon)