galacean/effects-runtime
Grade a repo

78

/ 100

GradeC

Good shape overall. A few tweaks would push it into the top tier.

Top 35% of 5,156 graded repos

It can load and render cool animation effects

Documentation82
Engineering71
Health89
TypeScript610MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

8 to address
  1. 1
    CI/CD14pt

    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.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Dependency manifest6pt

    Add a one-line description to package.json. It appears in npm search and on GitHub.

  4. 4
    Dependency manifest6pt

    Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

82

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

71

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.

Tests18pt100

Test files detected (plugin-packages/alipay-downgrade/test).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

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 health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 25
    Forks
  • 119
    Releaseslatest 2y ago

Community

  • 37% - Weak
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 610
    Watchers

Responsiveness

  • 2h
    Median issue response
  • 2h
    Median PR merge time
  • 12
    Open issues
Repository files32 root entries
  • .claude
  • .github
    Good: Dependabot covers 6 ecosystems (npm, npm, npm, npm, npm, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • .husky
  • docs
  • packages
  • plugin-packages
    Good: Test files detected (plugin-packages/alipay-downgrade/test).
  • scripts
  • types
  • web-packages
  • .coderabbit.yaml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintrc.js
  • .gitignore
    Good: .gitignore present.
  • .lintstagedrc.json
  • .npmrc
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • CHANGELOG-zh_CN.md
  • CHANGELOG.md
  • CLAUDE.md
  • commitlint.config.js
  • 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.
  • pnpm-workspace.yaml
  • README-zh_CN.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.
  • README.md
  • tsconfig.base.json
  • tsconfig.check.json
  • tsconfig.external.json
  • tsconfig.json
  • typedoc.base.json
  • typedoc.json
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/galacean/effects-runtime)](https://www.repo-grade.com/report/galacean/effects-runtime)

More graded TypeScript repos