tysonxor/rxjs_course

0

/ 100

Documentation60
Engineering53
Health45
JavaScript09y ago
Grade a repo

Rough and inactive. Tests, CI, and a fuller README would revive it.

Learning RxJS

Documentation

60

README12pt10

README is present.

Contributing guide5pt77

CONTRIBUTING guide found.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

A license file is present.

Engineering

53

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

Tests18pt35

Test files detected (node_modules/JSONStream/test).

CI/CD14pt100

CI is configured (node_modules/JSONStream/.travis.yml).

Linting and formatting5pt100

Linter or formatter configured (node_modules/acorn/.editorconfig).

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
  • build
    Issue: Build artifacts or local files may be committed (build/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • node_modules
    Good: A license file is present.
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Code of conduct present.
    Good: Test files detected (node_modules/JSONStream/test).
    Good: CI is configured (node_modules/JSONStream/.travis.yml).
    Good: Linter or formatter configured (node_modules/acorn/.editorconfig).
    Good: Environment pinned via node_modules/nodemon/Dockerfile.
  • public
  • src-client
  • src-server
  • .babelrc
  • gulpfile.js
  • package.json
    Good: Dependency manifest found (package.json).
  • README.txt
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.