jean-luc1203/jkbms-rs485-addon

0

/ 100

Documentation69
Engineering25
Health85
JavaScript83Other3d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

Management of one or more JK-BMS BMS via RS485 port and modbus protocol

Documentation

69

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.

Install and run instructions9pt45

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Other.

Engineering

25

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 found.

→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

CI/CD14pt40

CI is configured (.github/workflows/FAQ-creation.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

85

Housekeeping3pt40

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Dependency manifest6pt82

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/FAQ-creation.yml).
    Good: Issue or PR templates present.
  • Documentation
  • images
  • rootfs
  • standalone
  • translations
  • build.yaml
  • CHANGELOG.md
  • COMMERCIAL-LICENSE.md
  • config.yaml
  • dashboard_sync.js
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • DOCS.md
  • FAQ.md
  • icon.png
  • JK-BMS-Diagnostics.yaml
  • LICENSE
    Good: Licensed under Other.
  • logo.png
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • repository.json
  • SAFETY.md