openxla/shardy

0

/ 100

Documentation78
Engineering46
Health91
MLIR191Apache-2.01d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

MLIR-based partitioning system

Documentation

78

Contributing guide5pt47

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

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_test_bazel.yml).

Tests18pt80

Test files detected (shardy/dialect/mpmd/ir/test).

Project health

91

Housekeeping3pt40

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Dependency manifest6pt100

Dependency manifest found (shardy/integrations/python/jax/mpmd/pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 38
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 6d 2h
    Median issue response
  • 2h
    Median PR merge time
  • 82
    Open issues
Repository files13 root entries
  • .github
    Good: CI is configured (.github/workflows/build_test_bazel.yml).
  • docs
  • rfcs
  • shardy
    Good: Test files detected (shardy/dialect/mpmd/ir/test).
    Good: Dependency manifest found (shardy/integrations/python/jax/mpmd/pyproject.toml).
  • third_party
  • .bazelrc
  • .bazelversion
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MODULE.bazel
  • MODULE.bazel.lock
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • WORKSPACE