mwakidenis/mwakidenis.com

0

/ 100

Documentation66
Engineering22
Health89
JavaScript46Other3d ago
Grade a repo

Some interest. A stronger README and CI would help.

⚡mwakidenis.com — Modern Next.js Creative Portfolio & Blog Platform with GSAP Animations, Markdown Content Management, Dynamic Project Layouts, Responsive Design, and Cloudflare Pages Deployment

Documentation

66

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.

README12pt50

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

22

Tests18pt0

No tests detected anywhere in the repository.

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

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

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

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

Linting and formatting5pt100

Linter or formatter configured (lint script in package.json).

Project health

89

Dependency manifest6pt65

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
  • public
  • src
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • CLOUDFLARE_DEPLOYMENT.md
  • cloudflare.env.example
  • jsconfig.json
  • LICENSE
    Good: Licensed under Other.
  • next.config.js
  • 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.
    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.
  • SECURITY.md
    Good: Security policy present.
  • updates.txt
  • wrangler.toml