engmung/patternflow

0

/ 100

Documentation87
Engineering31
Health100
TypeScript131CC-BY-SA-4.01d ago
Grade a repo

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

An open-source LED synthesizer. Play light patterns with your fingertips. A modern reinterpretation of Nam June Paik's Participation TV (1963).

Documentation

87

Contributing guide5pt53

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.

README12pt85

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under CC-BY-SA-4.0.

Engineering

31

Tests18pt0

No tests detected anywhere in the repository.

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

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Reproducibility6pt70

Lockfile present (firmware/tools/package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (web/eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (firmware/tools/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)
  • 8
    Forks
  • 3
    Releaseslatest 1mo ago

Community

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

Responsiveness

  • 4d 9h
    Median issue response
  • <1h
    Median PR merge time
  • 13
    Open issues
Repository files15 root entries
  • .agents
  • .github
    Good: Issue or PR templates present.
  • docs
  • firmware
    Good: Lockfile present (firmware/tools/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (firmware/tools/package.json).
  • hardware
  • tools
  • web
    Good: Linter or formatter configured (web/eslint.config.mjs).
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • BUILD_GUIDE.md
  • CHANGELOG.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.
    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.
  • LICENSE-CC-BY-SA
  • LICENSE-MIT
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.