weponusa/teachany-courseware

0

/ 100

Documentation33
Engineering25
Health100
JavaScript10Other1d ago
Grade a repo

Some interest. A stronger README and CI would help.

TeachAny courseware assets, examples, community gallery and media resources

Documentation

33

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

README12pt38

This repository is large enough that GitHub truncated the file tree. The scan is based on a partial file list, so some checks may under-report.

License6pt100

Licensed under Other.

Engineering

25

Tests18pt0

No tests detected anywhere in the repository.

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

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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

Reproducibility6pt70

Lockfile present (community/bio-classification/remotion/package-lock.json). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (community/bio-classification/remotion/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)
  • 3
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • 2h
    Median PR merge time
  • 47
    Open issues
Repository files19 root entries
  • _reading_site
  • .cursor
  • .github
    Good: CI is configured (.github/workflows/community-publish.yml).
  • .wrangler
  • assets
  • community
    Good: Lockfile present (community/bio-classification/remotion/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (community/bio-classification/remotion/package.json).
  • data
  • _redirects
  • _worker.bundle
  • .gitignore
    Good: .gitignore present.
  • .nojekyll
  • 404.html
  • AGNES_IMAGE_SETUP.md
  • CNAME
  • commercial-license.html
  • courseware-registry.json
  • FEEDBACK_SETUP.md
  • PBL_LOG_SETUP.md
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.