craigchat/craig

0

/ 100

Documentation52
Engineering67
Health94
TypeScript533ISC1d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Craig is a multi-track voice recorder for Discord.

Documentation

52

README12pt28

README is present.

Contributing guide5pt47

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

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

Install and run instructions9pt55

README documents how to install the project.

License6pt100

Licensed under ISC.

Engineering

67

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

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

Tests18pt80

A test script is configured in package.json.

Reproducibility6pt92

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

94

Dependency manifest6pt82

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

Community

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

Responsiveness

  • 2h
    Median issue response
  • 9h
    Median PR merge time
  • 20
    Open issues
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot configured for npm.
  • apps
  • cook
  • prisma
  • scripts
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env.example
  • .eslintrc.js
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +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.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • cook.sh
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • dockerfile
  • install.config.example
  • install.sh
  • json-convert.js
  • LICENSE
    Good: Licensed under ISC.
  • locale
  • logrecent.js
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SELFHOST.md
  • stats.js
  • tsconfig.json
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.