scottbez1/smartknob

0

/ 100

Documentation76
Engineering64
Health75
C++21,879Other2y ago
Grade a repo

A major project that has gone quiet. Signs of life would reassure users.

Haptic input knob with software-defined endstops and virtual detents

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

Engineering

64

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.

CI/CD14pt57

CI is configured (.github/workflows/electronics.yml).

Reproducibility6pt70

Lockfile present (proto/Pipfile.lock). Installs are reproducible.

Tests18pt80

Test files detected (firmware/test).

Linting and formatting5pt100

Linter or formatter configured (software/js/packages/example-cli/.eslintrc).

Project health

75

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Dependency manifest6pt100

Dependency manifest found (proto/Pipfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/electronics.yml).
  • .vscode
  • cad
  • doc
  • electronics
  • firmware
    Good: Test files detected (firmware/test).
  • proto
    Good: Lockfile present (proto/Pipfile.lock). Installs are reproducible.
    Good: Dependency manifest found (proto/Pipfile).
  • scripts
  • software
    Good: Linter or formatter configured (software/js/packages/example-cli/.eslintrc).
  • thirdparty
  • util
  • __init__.py
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • LICENSE.txt
    Good: Licensed under Other.
  • platformio.ini
  • 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.