unzorz/crambot-java-edition

0

/ 100

Documentation40
Engineering0
Health53
Java24y ago
Grade a repo

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

Documentation

40

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt0

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.

README12pt38

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

0

Tests18pt0

No tests detected anywhere in the repository.

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

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

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.

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.

Project health

53

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (build.gradle).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 2
    Releaseslatest 4y ago

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files12 root entries
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
  • gradle
  • src
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .syncmetadata
  • build.gradle
    Good: Dependency manifest found (build.gradle).
  • config.json
  • gradlew
  • gradlew.bat
  • 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 some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    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.
  • settings.gradle