aterai/java-swing-tips

0

/ 100

Documentation41
Engineering39
Health80
618MIT1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

Java Swing example.

Documentation

41

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt60

README is present.

License6pt100

Licensed under MIT.

Engineering

39

Tests18pt0

No tests detected anywhere in the repository.

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

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

CI is configured (Jenkinsfile).

Linting and formatting5pt100

Java/Kotlin linting configured (.editorconfig).

Project health

80

Housekeeping3pt40

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt100

Dependency manifest found (build.gradle).

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • 2d 13h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files21 root entries
  • alphabets
  • examples
  • tags
  • .editorconfig
    Good: Java/Kotlin linting configured (.editorconfig).
  • .gitattributes
  • all.xml
  • build.gradle
    Good: Dependency manifest found (build.gradle).
  • build.xml
  • checks.xml
  • checkstyle.gradle
  • excludefilter.xml
  • google_checks21.xml
  • google_checks8.xml
  • Jenkinsfile
    Good: CI is configured (Jenkinsfile).
  • LICENSE.txt
    Good: Licensed under MIT.
  • logging.properties
  • pmd.gradle
  • README.md
    Good: README is present.
    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.
    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.
  • ruleset.xml
  • settings.gradle
  • sun_checks.xml