manishankarvakta/dh-node

0

/ 100

Documentation19
Engineering61
Health45
JavaScript03y ago
Grade a repo

Lots of room to improve. Start with a README and CI.

Using Crypto with Note

Documentation

19

README12pt0

README is present.

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

License6pt100

A license file is present.

Engineering

61

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.

Tests18pt35

Test files detected (node_modules/@protobufjs/aspromise/tests).

Reproducibility6pt80

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

CI/CD14pt100

CI is configured (node_modules/body-parser/node_modules/debug/.travis.yml).

Linting and formatting5pt100

Linter or formatter configured (node_modules/body-parser/node_modules/debug/.eslintrc).

Project health

45

Housekeeping3pt0

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Activity5pt5

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

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

Dependency manifest6pt55

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files9 root entries
  • node_modules
    Good: A license file is present.
    Good: Test files detected (node_modules/@protobufjs/aspromise/tests).
    Good: CI is configured (node_modules/body-parser/node_modules/debug/.travis.yml).
    Good: Linter or formatter configured (node_modules/body-parser/node_modules/debug/.eslintrc).
    Good: Environment pinned via node_modules/ts-poet/.nvmrc.
    Good: Security policy present.
    Issue: Build artifacts or local files may be committed (node_modules/.bin) (−40 pts).Fix: Remove them and add to .gitignore.
  • aes256.js
  • DH.js
  • ECDH.js
  • gcm.js
  • index.tsx
  • 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.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.