41
/ 100
Getting noticed, but rough fundamentals could turn visitors away.
Sharding-Sphere website & documents
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 D (63).
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
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add a lint step to catch style issues automatically.
- 4CI/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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
19
This repository is large enough that GitHub truncated the file tree. The scan is based on a partial file list, so some checks may under-report.
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.
Licensed under Other.
Engineering
46
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.
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 (.github/workflows/build-pdf.yml).
Test files detected (document/1.0.0/cn/reference/test).
Project health
68
No dependency manifest detected at root.
→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 0 / 3Commits (30d / 90d)
- 196Forks
- 0Releases
Community
- 50% - FairCommunity health
- 3 bus factorauthors own >50% of commits
- 172Watchers
Responsiveness
- 21hMedian issue response
- 3hMedian PR merge time
- 1Open issues
Repository files22 root entries
- .githubGood: CI is configured (.github/workflows/build-pdf.yml).
- benchmark
- blog
- charts
- community
- documentGood: Test files detected (document/1.0.0/cn/reference/test).
- .asf.yaml
- .gitignoreGood: .gitignore present.
- .htaccess
- AGENTS.md
- baidu_verify_codeva-2O5EunBJeU.html
- check.html
- LICENSE.txtGood: Licensed under Other.
- SourceHanSansSC-Bold.otf
- SourceHanSansSC-ExtraLight.otf
- SourceHanSansSC-Heavy.otf
- SourceHanSansSC-Light.otf
- SourceHanSansSC-Medium.otf
- SourceHanSansSC-Normal.otf
- SourceHanSansSC-Regular.otf
- SourceHanSansSC.zip.1
- SourceHanSerifSC.zip.1
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/apache/shardingsphere-doc)