matthewjberger/nightshade
Grade a repo

0

/ 100

GradeB

Well engineered for its size. A portfolio piece worth showing off.

Top 14% of 5,156 graded repos

A data-oriented game engine written in Rust with a custom ECS 🦀 Works on Windows/Linux/MacOS/Web

Documentation89
Engineering85
Health100
Rust36Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  3. 3
    Issue and PR templates6pt

    Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

  4. 4
    Issue and PR templates6pt

    A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

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

89

Contributing guide5pt47

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

85

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.

Reproducibility6pt80

Lockfile present (apps/editor/Cargo.lock). Installs are reproducible.

Tests18pt100

Test files detected (crates/nightshade-api/bindings/python/tests).

CI/CD14pt100

CI is configured (.github/workflows/rust.yml).

Linting and formatting5pt100

Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Cargo.toml).

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)
  • 0
    Forks
  • 14
    Releaseslatest 1mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 36
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files28 root entries
  • .github
    Good: CI is configured (.github/workflows/rust.yml).
  • apps
    Good: Lockfile present (apps/editor/Cargo.lock). Installs are reproducible.
    Good: Environment pinned via apps/editor/mise.toml.
  • assets
    Good: Licensed under Apache-2.0.
  • crates
    Good: Test files detected (crates/nightshade-api/bindings/python/tests).
  • docker
  • docs
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +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.
  • hooks
  • site
  • template
  • template_api
  • template_api_leptos
  • template_leptos
  • .gitignore
    Good: .gitignore present.
  • about.hbs
  • about.toml
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • CLAUDE.md
  • cliff.toml
  • CROSS.toml
  • deny.toml
  • justfile
  • LICENSE-APACHE
  • 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.
    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.
  • rust-toolchain
  • rustfmt.toml
    Good: Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).
  • steam_appid.txt
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/matthewjberger/nightshade)](https://www.repo-grade.com/report/matthewjberger/nightshade)

More graded Rust repos