bauddance/serialassistant

0

/ 100

Documentation82
Engineering57
Health83
Vue835MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

A serial port assistant that can be used directly in the browser.

Documentation

82

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 instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

57

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.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt80

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Tests18pt100

Test files detected (test).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

83

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt65

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 66
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 835
    Watchers

Responsiveness

  • 19h
    Median issue response
  • 13h
    Median PR merge time
  • 3
    Open issues
Repository files29 root entries
  • .vscode
  • docs
  • public
  • src
  • test
    Good: Test files detected (test).
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .nvmrc
  • .vercelignore
  • components.json
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • eslint.config.js
  • index.html
  • jsconfig.json
  • LICENSE
    Good: Licensed under MIT.
  • netlify.toml
  • nginx.conf
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • postcss.config.cjs
  • 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.
    Good: README documents how to run the project.
  • vercel.json
  • vite.config.js
  • vitest.config.js