luminolmc/luminol
Grade a repo

0

/ 100

GradeD

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

Higher than 47% of 5,156 graded repos

轻量级、优化且功能齐全的 Folia 分支，专为生存和无政府状态服务器而设计

Documentation91
Engineering30
Health100
Java536Other1mo 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 (88).

See your top fixes
Now
D
63
Potential
B
88

Top fixes

Highest-impact changes first, ranked by point weight

16 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

91

Contributing guide5pt61

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.

README12pt100

README is present.

License6pt100

Licensed under Other.

Engineering

30

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 Java/Kotlin linter configured.

→ Add Checkstyle or Spotless for Java formatting, or ktlint/Detekt for Kotlin. Run it via Maven/Gradle or as a CI step.

Reproducibility6pt12

No dependency lockfile found (−70 pts).

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

CI/CD14pt57

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (build.gradle.kts).

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)
  • 53
    Forks
  • 957
    Releaseslatest 2y ago

Community

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

Responsiveness

  • <1h
    Median issue response
  • 3h
    Median PR merge time
  • 13
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • docs
    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.
    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).
    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.
  • gradle
  • licenses
  • luminol-api
  • luminol-server
  • public
  • scripts
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • build.gradle.kts
    Good: Dependency manifest found (build.gradle.kts).
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE.md
    Good: Licensed under Other.
  • README_EN.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.
  • README.md
  • settings.gradle.kts
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/luminolmc/luminol)](https://www.repo-grade.com/report/luminolmc/luminol)

More graded Java repos