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

Tado cloud connector to control Tado devices

Documentation

76

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.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

86

CI/CD14pt57

CI is configured (.github/workflows/test-and-release.yml).

Reproducibility6pt90

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (test).

Linting and formatting5pt100

Linter or formatter configured (eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

91

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt90

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/test-and-release.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .vscode
  • admin
  • lib
  • test
    Good: Test files detected (test).
  • .DS_Store
    Issue: Build artifacts or local files may be committed (.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .releaseconfig.json
  • CHANGELOG_OLD.md
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • io-package.json
  • LICENSE
    Good: Licensed under MIT.
  • main.js
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • prettier.config.mjs
  • README.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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json