0

/ 100

GradeF

Getting some notice. Tests and CI would be the fastest wins.

Higher than 37% of 5,156 graded repos

Third-party dependencies for Apache Ratis

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 (70).

See your top fixes
Now
F
52
Potential
C
70

Top fixes

Highest-impact changes first, ranked by point weight

19 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  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

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

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

30

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.

README12pt30

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

48

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.

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.

Reproducibility6pt20

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/ci.yaml).

Tests18pt80

Test files detected (test).

Project health

100

Dependency manifest6pt100

Dependency manifest found (pom.xml).

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)
  • 30
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • -
    Median issue response
  • 12h
    Median PR merge time
  • 0
    Open issues
Repository files13 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yaml).
    Good: Dependabot covers 2 ecosystems (github-actions, maven). Dependencies stay current.
  • .mvn
  • dev-support
  • misc
  • test
    Good: Test files detected (test).
  • .asf.yaml
  • .gitignore
    Good: .gitignore present.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • mvnw
  • mvnw.cmd
  • NOTICE
  • pom.xml
    Good: Dependency manifest found (pom.xml).
  • 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 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.
    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.
    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.
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/apache/ratis-thirdparty)](https://www.repo-grade.com/report/apache/ratis-thirdparty)

More graded Shell repos