78/xiaozhi-esp32

0

/ 100

Documentation72
Engineering37
Health100
C++27,440MIT6d ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

An MCP-based chatbot | 一个基于MCP的聊天机器人

Documentation

72

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.

README12pt75

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

37

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/build.yml).

Reproducibility6pt70

Lockfile present (scripts/Image_Converter/requirements.txt). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (scripts/Image_Converter/requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • docs
  • main
  • partitions
  • scripts
    Good: Lockfile present (scripts/Image_Converter/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (scripts/Image_Converter/requirements.txt).
  • .clang-format
  • .gitignore
    Good: .gitignore present.
  • CMakeLists.txt
  • LICENSE
    Good: Licensed under MIT.
  • README_ja.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • README_zh.md
  • README.md
  • sdkconfig.defaults
  • sdkconfig.defaults.esp32
  • sdkconfig.defaults.esp32c3
  • sdkconfig.defaults.esp32c5
  • sdkconfig.defaults.esp32c6
  • sdkconfig.defaults.esp32p4
  • sdkconfig.defaults.esp32s3