aquatikjustice/supercargo
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

Documentation72
Engineering20
Health79
TypeScript19MITtoday

Documentation

72

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.

README12pt75

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

20

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.

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/CD14pt40

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

Reproducibility6pt70

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

Project health

79

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt85

Dependency manifest found (package.json).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 4
    Releaseslatest today

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 19
    Watchers

Responsiveness

  • 15h
    Median issue response
  • <1h
    Median PR merge time
  • 2
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/release-linux.yml).
  • assets
  • build
  • data
  • resources
  • scripts
  • src
  • tools
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • electron-builder.yml
  • electron.vite.config.ts
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
    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.
  • tsconfig.json
  • tsconfig.node.json
  • tsconfig.web.json