47
/ 100
Getting noticed, but rough fundamentals could turn visitors away.
Java Swing example.
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 C (79).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2README12pt
Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
- 3README12pt
Show a quick-start snippet so contributors can see what using your project looks like.
- 4README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
41
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under MIT.
Engineering
39
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
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 is configured (Jenkinsfile).
Java/Kotlin linting configured (.editorconfig).
Project health
80
No .gitignore found (−60 pts).
→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.
Repository has a description.
Dependency manifest found (build.gradle).
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 163Forks
- 0Releases
Community
- 42% - WeakCommunity health
- -authors own >50% of commits
- 617Watchers
Responsiveness
- 2d 13hMedian issue response
- <1hMedian PR merge time
- 3Open issues
Repository files21 root entries
- alphabets
- examples
- tags
- .editorconfigGood: Java/Kotlin linting configured (.editorconfig).
- .gitattributes
- all.xml
- build.gradleGood: Dependency manifest found (build.gradle).
- build.xml
- checks.xml
- checkstyle.gradle
- excludefilter.xml
- google_checks21.xml
- google_checks8.xml
- JenkinsfileGood: CI is configured (Jenkinsfile).
- LICENSE.txtGood: Licensed under MIT.
- logging.properties
- pmd.gradle
- README.mdGood: 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
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/aterai/java-swing-tips)