ginkohub/mushi

0

/ 100

Documentation81
Engineering48
Health97
JavaScript17MPL-2.03d ago
Grade a repo

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

🪲 Mushi is a simple WhatsApp bot.

Documentation

81

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.

README12pt90

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under MPL-2.0.

Engineering

48

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.

Reproducibility6pt70

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

Tests18pt80

A test script is configured in package.json.

Linting and formatting5pt100

Linter or formatter configured (biome.json).

Project health

97

Dependency manifest6pt90

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files11 root entries
  • plugins
  • src
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • biome.json
    Good: Linter or formatter configured (biome.json).
  • example.js
  • LICENSE
    Good: Licensed under MPL-2.0.
  • mushi.png
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • 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.
    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.
    Good: README documents how to run the project.