gkjohnson/urdf-loaders

0

/ 100

Documentation64
Engineering77
Health100
JavaScript799Apache-2.03d ago
Grade a repo

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

URDF Loaders for Unity and THREE.js with example ATHLETE URDF Files open sourced from NASA JPL

Documentation

64

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt58

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

License6pt100

Licensed under Apache-2.0.

Engineering

77

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.

Reproducibility6pt70

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

Tests18pt80

Test files detected (javascript/test).

CI/CD14pt100

CI is configured (.github/workflows/examples-build.yml).

Linting and formatting5pt100

Linter or formatter configured (javascript/.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (javascript/package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files7 root entries
  • .github
    Good: CI is configured (.github/workflows/examples-build.yml).
  • javascript
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Test files detected (javascript/test).
    Good: Linter or formatter configured (javascript/.editorconfig).
    Good: Lockfile present (javascript/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (javascript/package.json).
  • unity
  • urdf
  • .gitignore
    Good: .gitignore present.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • 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.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.