slush97/grimoire

0

/ 100

Documentation93
Engineering76
Health92
TypeScript20MIT1d ago
Grade a repo

Well engineered for its size. A portfolio piece worth showing off.

Mod manager for Deadlock

Documentation

93

Contributing guide5pt74

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

76

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.

Reproducibility6pt70

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

CI/CD14pt72

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

Tests18pt100

Test files detected (src/components/locker/HeroPoseViewer.test.ts).

Linting and formatting5pt100

Linter or formatter configured (eslint.config.js).

Project health

92

Dependency manifest6pt75

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

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)
  • 5
    Forks
  • 54
    Releaseslatest 2mo ago

Community

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

Responsiveness

  • 2h
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files30 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • .husky
  • aur
  • docs
  • electron
  • fonts
  • public
  • resources
  • scripts
  • src
    Good: Test files detected (src/components/locker/HeroPoseViewer.test.ts).
  • tools
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • electron-builder.yml
  • electron.vite.config.ts
  • eslint.config.js
    Good: Linter or formatter configured (eslint.config.js).
  • index.html
  • LICENSE
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tsconfig.app.json
  • tsconfig.json
  • tsconfig.node.json
  • vitest.config.ts