Some interest. A stronger README and CI would help.
AquaPi for ESPHome & Home Assistant
Documentation
68
README documents how to install the project.
CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.
→ Add setup instructions, code style notes, and how to run tests.
README is present.
Licensed under Apache-2.0.
Engineering
30
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.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
CI is configured (.github/workflows/ci.yml).
Issue or PR templates present.
Project health
58
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 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)
- 15Forks
- 30Releaseslatest 1y ago
Community
- —Community health
- —authors own >50% of commits
- 96Watchers
Responsiveness
- 11hMedian issue response
- <1hMedian PR merge time
- 0Open issues
Repository files19 root entries
- .githubGood: CI is configured (.github/workflows/ci.yml).Good: Dependabot configured for github-actions.Good: Issue or PR templates present.
- archive
- assets
- Atlas EZO docs
- blueprints
- common
- static
- .gitattributes
- .gitignoreGood: .gitignore present.
- aquapi_config_optical.factory.yaml
- aquapi_config_optical.yaml
- aquapi_config.factory.yaml
- aquapi_config.yaml
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- CONTRIBUTING.mdIssue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- DEBUGGING.md
- LICENSEGood: Licensed under Apache-2.0.
- README.mdGood: 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.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- SECURITY.mdGood: Security policy present.