symmetricdevs/supersymmetry
Grade a repo

55

/ 100

GradeF

Popular for its size, but the engineering basics lag behind the interest.

Higher than 40% of 5,156 graded repos

Repository for the Supersymmetry Minecraft Modpack

Documentation75
Engineering37
Health68
Groovy283LGPL-3.04mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (85).

See your top fixes
Now
F
55
Potential
B
85

Top fixes

Highest-impact changes first, ranked by point weight

18 to address
  1. 1
    Tests18pt

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

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

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

75

README12pt55

README is present.

Contributing guide5pt69

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under LGPL-3.0.

Engineering

37

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.

CI/CD14pt57

CI is configured (.github/workflows/build.yaml).

Reproducibility6pt70

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

Issue and PR templates6pt100

Issue or PR templates present.

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

  • 68 / 242
    Commits (30d / 90d)
  • 127
    Forks
  • 59
    Releaseslatest 1y ago

Community

  • 62% - Fair
    Community health
  • -
    authors own >50% of commits
  • 283
    Watchers

Responsiveness

  • <1h
    Median issue response
  • 4h
    Median PR merge time
  • 86
    Open issues
Repository files28 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yaml).
    Good: Issue or PR templates present.
  • build
  • config
  • groovy
  • journeymap
  • mods
  • resourcepacks
  • resources
    Good: Lockfile present (resources/gregtech/package-lock.json). Installs are reproducible.
  • structures
  • .gitignore
    Good: .gitignore present.
  • .packwizignore
  • CHANGELOG.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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.
    Good: Contributing guide describes code style expectations.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • findmissingmaterials.py
  • icon.png
  • imgui.ini
  • index.toml
  • instance.png
  • LICENSE
    Good: Licensed under LGPL-3.0.
  • MaterialIDRefactorer.py
  • modListValidator.py
  • modValidationFile.dat
  • modValidationFile.pickle
  • pack.toml
  • packwiz
  • packwiz.exe
  • README_PT.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • README.md
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/symmetricdevs/supersymmetry)](https://www.repo-grade.com/report/symmetricdevs/supersymmetry)

More graded Groovy repos