apache/shardingsphere-doc

0

/ 100

Documentation19
Engineering46
Health68
HTML172Other1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

Sharding-Sphere website & documents

Documentation

19

README12pt0

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.

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.

License6pt100

Licensed under Other.

Engineering

46

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

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.

CI/CD14pt57

CI is configured (.github/workflows/build-pdf.yml).

Tests18pt80

Test files detected (document/1.0.0/cn/reference/test).

Project health

68

Dependency manifest6pt0

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

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 172
    Watchers

Responsiveness

  • 21h
    Median issue response
  • 3h
    Median PR merge time
  • 1
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/build-pdf.yml).
  • benchmark
  • blog
  • charts
  • community
  • document
    Good: Test files detected (document/1.0.0/cn/reference/test).
  • .asf.yaml
  • .gitignore
    Good: .gitignore present.
  • .htaccess
  • AGENTS.md
  • baidu_verify_codeva-2O5EunBJeU.html
  • check.html
  • LICENSE.txt
    Good: 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