greenuniversitycomputerclub/gucc
Grade a repo

0

/ 100

GradeF

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

Documentation58
Engineering36
Health82
TypeScript5today

Documentation

58

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt70

README is present.

Install and run instructions9pt100

README documents how to install the project.

Engineering

36

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

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/codeql.yml).

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.json).

Project health

82

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 manifest6pt92

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

Community

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

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files22 root entries
  • .cursor
  • .github
    Good: CI is configured (.github/workflows/codeql.yml).
  • .husky
  • app
  • components
  • data
  • lib
  • public
  • .env.example
  • .eslintrc.json
    Good: Linter or formatter configured (.eslintrc.json).
  • .gitignore
    Good: .gitignore present.
  • .tool-versions
    Good: Environment pinned via .tool-versions.
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • components.json
  • next.config.ts
  • package-lock.json
  • package.json
    Good: Dependency manifest found (package.json).
  • postcss.config.mjs
  • proxy.ts
  • 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.
  • tailwind.config.ts
  • tsconfig.json