rangi42/polishedcrystal

0

/ 100

Documentation72
Engineering16
Health68
Assembly1,5481d ago
Grade a repo

Real traction, but rough engineering makes it hard for contributors to trust.

An upgrade to Pokémon Crystal. Brings features and content up to date, and adds some original content.

Documentation

72

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.

README12pt75

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

A license file is present.

Engineering

16

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

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

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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)
  • 309
    Forks
  • 17
    Releaseslatest 1y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 1,548
    Watchers

Responsiveness

  • 31d 13h
    Median issue response
  • <1h
    Median PR merge time
  • 149
    Open issues
Repository files37 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
  • audio
  • bsp
  • constants
  • data
  • docs
  • engine
  • gfx
  • home
  • macros
  • maps
  • material
  • patches
  • ram
  • screenshots
  • tools
    Good: A license file is present.
  • utils
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .rgbds-version
  • audio.asm
  • CHANGELOG.md
  • CREDITS.md
  • FAQ.md
  • FEATURES.md
  • gfx.py
  • home.asm
  • includes.asm
  • INSTALL.md
  • layout.link
  • main.asm
  • Makefile
  • ram.asm
  • 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.
    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.
    Good: README documents how to run the project.
  • rgbdscheck.asm
  • TODO.md
  • vc.patch.template