ari-s-123/pdp-project-1

0

/ 100

Documentation70
Engineering60
Health65
TypeScript0MIT1y ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

An OOP implementation of the models that would be used in a cocktail recipe sharing app.

Documentation

70

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

60

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 (tests).

Reproducibility6pt70

Lockfile present (bun.lock). Installs are reproducible.

CI/CD14pt100

CI is configured (.github/workflows/lint-test.yml).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Project health

65

Activity5pt20

No pushes in over a year (−80 pts).

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

Dependency manifest6pt55

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

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 files15 root entries
  • .github
    Good: CI is configured (.github/workflows/lint-test.yml).
  • .vscode
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • eslint.config.js
  • LICENSE
    Good: Licensed under MIT.
  • MixSmart Spec Sheet - Aritra Saharay.pdf
  • OOP Usage.md
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
  • tsconfig.json