megamek/mekhq

0

/ 100

Documentation64
Engineering82
Health100
Java157Other1d ago
Grade a repo

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

MekHQ is a campaign management tool that provides an immersive experience in managing a BattleTech mercenary unit. It integrates with MegaMek for battles and MegaMekLab for unit customization, covering personnel, finances, and logistics.

Documentation

64

Contributing guide5pt5

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.

Install and run instructions9pt45

README documents how to install the project.

README12pt85

README is present.

License6pt100

Licensed under Other.

Engineering

82

Reproducibility6pt12

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Tests18pt80

Test files detected (MekHQ/unittests/mekhq/campaign/AbstractLocationTest.java).

CI/CD14pt100

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

Linting and formatting5pt100

Java/Kotlin linting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (build.gradle).

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)
  • 223
    Forks
  • 93
    Releaseslatest 9y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 157
    Watchers

Responsiveness

  • 6h
    Median issue response
  • 1d 5h
    Median PR merge time
  • 713
    Open issues
Repository files21 root entries
  • .github
    Good: CI is configured (.github/workflows/checkstyle.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • config
  • gradle
  • MekHQ
    Good: Test files detected (MekHQ/unittests/mekhq/campaign/AbstractLocationTest.java).
  • .editorconfig
    Good: Java/Kotlin linting configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .mailmap
  • build.gradle
    Good: Dependency manifest found (build.gradle).
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODEOWNERS
  • CONTRIBUTORS.md
  • eclipse.xml
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
    Good: Licensed under Other.
  • LICENSE.assets
  • LICENSE.code
  • MHQMorale-Simulation-Analysis.txt
  • 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.
    Good: README includes status badges.
    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.
  • settings.gradle