ejd799/modderyNew scan
21/ 100 · F

Lots of room to improve. Start with a README and CI.

An open-source, web-based mod builder for Minecraft

JavaScript3 starsupdated 2mo ago
DocumentationREADME, setup, examples, license
16
EngineeringTests, CI, linting, lockfiles
11
Project healthDescription, activity, stars, deps
54

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Tests
    EngineeringIssue

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

  2. 2
    CI/CD
    EngineeringIssue

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

  3. 3
    CI/CD
    EngineeringIssue

    Add `pull_request:` to the workflow `on:` triggers.

Detailed breakdown

Documentation

16
  • README10
    • README is present.
    • README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Expand with a description, install steps, usage, and examples.
    • README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • No live demo link in the README (−20 pts).Link to a deployed version, docs site, or demo video. Users want to see it running.
    • No status badges in the README (−10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
  • Install and run instructions45
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use the project.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License0
    • No license detected.Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
  • Contributing guide0
    • 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.
    • Optional: add a Code of Conduct.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

11
  • Tests0
    • No tests detected anywhere in the repository.Add automated tests. They prove the code works and give contributors confidence to make changes.
  • CI/CD40

    Not applicable?

    • CI is configured (.github/workflows/static.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • CI does not appear to trigger on pull requests (−17 pts).Add `pull_request:` to the workflow `on:` triggers.
    • CI does not run a lint or format check (−15 pts).Add a lint step to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
  • Linting and formatting0
    • 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.
  • Reproducibility0
    • No dependency lockfile found (−70 pts).Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates0
    • 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.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

54
  • Dependency manifest0
    • 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 metadata100
    • Repository has a description.
    • Primary language detected: JavaScript.
  • Activity80
    • Actively maintained (pushed within 3 months).
    • Last pushed 1-3 months ago (−20 pts). A push within 30 days earns the full 100.A recent commit keeps the project looking alive to visitors and contributors.
  • Housekeeping40
    • No .gitignore found (−60 pts).Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • 28% — Weak
    Community health
  • —
    authors own >50% of commits
  • 3
    Watchers

Responsiveness

  • 26d 24h
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files30 root entries
  • .github
    Good: CI is configured (.github/workflows/static.yml).
  • custom_textures
  • editor
  • export_utils
  • exporter
  • fonts
  • images
  • pwa_icons
  • themes
  • database_libs.js
  • editor_theme_template_dark.css
  • editor_theme_template_light.css
  • editor_theme_template.json
  • FileSaver.js
  • index.html
  • item_definitions.js
  • jquery-3.7.1.min.js
  • jquery-ui.min.css
  • jquery-ui.min.js
  • jquery-ui.theme.min.css
  • jszip.min.js
  • libs.js
  • main.js
  • moddery_icon.png
  • moddery_logo.svg
  • pwa_manifest.json
  • 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 little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • styles.css
  • test.html
  • textComponentEditor.js