apecloud/kubeblocks-addons
Grade a repo

72

/ 100

GradeC

Solid foundation. Invest in docs and CI to grow from here.

Top 43% of 5,156 graded repos

KubeBlocks add-ons.

Documentation61
Engineering68
Health100
Shell79Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

13 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

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

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

61

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.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt78

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

68

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

CI/CD14pt57

CI is configured (.github/workflows/check-chart-pr-review.yml).

Tests18pt80

Test files detected (.github/scripts/test_comprehensive_release_notes.py).

Reproducibility6pt80

Lockfile present (addons/elasticsearch/agent/go.sum). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (addons/elasticsearch/agent/go.mod).

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

Community

  • 62% - Fair
    Community health
  • 6 bus factor
    authors own >50% of commits
  • 79
    Watchers

Responsiveness

  • <1h
    Median issue response
  • 1h
    Median PR merge time
  • 99
    Open issues
Repository files14 root entries
  • .github
    Good: Test files detected (.github/scripts/test_comprehensive_release_notes.py).
    Good: CI is configured (.github/workflows/check-chart-pr-review.yml).
    Good: Issue or PR templates present.
  • addons
    Good: Lockfile present (addons/elasticsearch/agent/go.sum). Installs are reproducible.
    Good: Environment pinned via addons/elasticsearch/agent/Dockerfile.
    Good: Dependency manifest found (addons/elasticsearch/agent/go.mod).
  • addons-cluster
  • docker
  • examples
  • hack
  • shellspec
  • utils
  • .gitignore
    Good: .gitignore present.
  • .shellspec
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MAINTAINERS.md
  • Makefile
  • README.md
    Good: README is present.
    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.
    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.
    Good: README includes status badges.
    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.
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/apecloud/kubeblocks-addons)](https://www.repo-grade.com/report/apecloud/kubeblocks-addons)

More graded Shell repos