nnoggie/mythicdungeontools
Grade a repo

0

/ 100

GradeF

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

Higher than 40% of 5,156 graded repos

World of Warcraft AddOn for planning and optimizing Mythic+ dungeon runs

Documentation54
Engineering51
Health68
Lua358GPL-2.01mo 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 C (70).

See your top fixes
Now
F
55
Potential
C
70

Top fixes

Highest-impact changes first, ranked by point weight

24 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  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 `pull_request:` to the workflow `on:` triggers.

  4. 4
    CI/CD14pt

    Add a lint step to catch style issues automatically.

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

54

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt75

README is present.

License6pt100

Licensed under GPL-2.0.

Engineering

51

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/CD14pt40

CI is configured (.github/workflows/update-wow-interface.yml).

Tests18pt80

Test files detected (Developer/Tests).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

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)
  • 236
    Forks
  • 506
    Releaseslatest 8y ago

Community

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

Responsiveness

  • 8h
    Median issue response
  • <1h
    Median PR merge time
  • 10
    Open issues
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/update-wow-interface.yml).
  • AceGUIWidgets
  • Developer
    Good: Test files detected (Developer/Tests).
  • libs
  • Locales
  • Midnight
  • MistsOfPandaria
  • Modules
  • scripts
  • Textures
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .luarc.json
  • AGENTS.md
  • Bindings.xml
  • BuildCheck.lua
  • CHANGELOG.txt
  • CONTRIBUTING.md
    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.
  • cspell.json
  • init.lua
  • LICENSE
    Good: Licensed under GPL-2.0.
  • locales.xml
  • MythicDungeonTools.lua
  • MythicDungeonTools.toc
  • pkgmeta.yaml
  • 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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • Utility.lua
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/nnoggie/mythicdungeontools)](https://www.repo-grade.com/report/nnoggie/mythicdungeontools)

More graded Lua repos