0
/ 100
The fundamentals need work — start with CI and the README.
Bitcoin USB Hardware Wallet Interface library
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 (73).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
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.
- 3README12pt
Expand with a description, install steps, usage, and examples.
- 4README12pt
Add more sections (Overview, Install, Usage, Contributing) using ## headings.
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
44
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.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
Licensed under Apache-2.0.
Engineering
29
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.
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.
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.
Test files detected (src/test).
Project health
100
Dependency manifest found (build.gradle).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 11Forks
- 0Releases
Community
- 37% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 9Watchers
Responsiveness
- 4hMedian issue response
- 1d 9hMedian PR merge time
- 3Open issues
Repository files9 root entries
- gradle
- srcGood: Test files detected (src/test).
- .gitignoreGood: .gitignore present.
- build.gradleGood: Dependency manifest found (build.gradle).
- gradlew
- gradlew.bat
- LICENSEGood: Licensed under Apache-2.0.
- README.mdGood: 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.Good: README has code examples.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.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.Good: README documents how to run the project.
- settings.gradle
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/sparrowwallet/lark)