syasj/hushshot
Grade a repo

83

/ 100

GradeC

Solid engineering. The biggest lever is CI. Impressive for a brand-new repo.

Top 33% of 5,156 graded repos

HushShot — free, offline screenshot & PDF redaction tool. Auto-blurs credit cards, SSNs, emails, phones, addresses, API keys, faces & QR codes and strips EXIF/GPS metadata. 100% in your browser, nothing uploaded.

Documentation94
Engineering64
Health94
JavaScript1MIT11d ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

94

Contributing guide5pt78

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

64

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

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

Reproducibility6pt90

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

Tests18pt100

Test files detected (tests).

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

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)
  • 0
    Forks
  • 0
    Releases

Community

  • 71% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 1
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 7
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
  • desktop
  • docs
  • e2e
  • public
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • index.html
  • 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.
    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.
  • SECURITY.md
    Good: Security policy present.
  • vite.config.js
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/syasj/hushshot)](https://www.repo-grade.com/report/syasj/hushshot)

More graded JavaScript repos