nliaudat/esphome_ai_component
Grade a repo

72

/ 100

GradeC

Solid foundation. Invest in docs and CI to grow from here.

Top 43% of 5,156 graded repos

A component to run AI model on esphome

Documentation74
Engineering62
Health96
C++55MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

  3. 3
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  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

74

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.

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

62

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Tests18pt80

Test files detected (tests).

Reproducibility6pt80

Lockfile present (components/data_collector/data_extractor/requirements.txt). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

96

Dependency manifest6pt86

Dependency manifest found (pyproject.toml).

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

  • 57% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 55
    Watchers

Responsiveness

  • 16h
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files41 root entries
  • .ai
  • .github
    Good: Issue or PR templates present.
  • .greptile
  • boards
  • components
    Good: Lockfile present (components/data_collector/data_extractor/requirements.txt). Installs are reproducible.
    Good: Environment pinned via components/data_collector/server/Dockerfile.
  • docs
  • draw_regions
  • models
  • script
  • tests
    Good: Test files detected (tests).
  • tools
  • wiki
  • .clang-format
  • .clang-tidy
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .flake8
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .yamllint
  • camera_options.yaml
  • camera_webserver.yaml
  • CODEOWNERS
  • config_analog_reader_test.yaml
  • config_ssocr_test.yaml
  • config.yaml
  • debug_board.yaml
  • esp32_camera.yaml
  • fuzz_parallel.py
  • globals.yaml
  • lan.yaml
  • licence.md
    Good: Licensed under MIT.
  • logger.yaml
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    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.
  • secrets.yaml.example
  • SECURITY.md
    Good: Security policy present.
  • sensor_others.yaml
  • switch_others.yaml
  • time.yaml
  • todo.md
  • wifi.yaml
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/nliaudat/esphome_ai_component)](https://www.repo-grade.com/report/nliaudat/esphome_ai_component)

More graded C++ repos