mhogrefe/malachite

0

/ 100

Documentation38
Engineering80
Health100
Rust579LGPL-3.01d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

An arbitrary-precision arithmetic library for Rust.

Documentation

38

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.

README12pt50

README is present.

License6pt100

Licensed under LGPL-3.0.

Engineering

80

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.

Reproducibility6pt70

Lockfile present (Cargo.lock). Installs are reproducible.

CI/CD14pt85

CI is configured (.github/workflows/rust.yml).

Tests18pt100

Test files detected (malachite-base/tests).

Linting and formatting5pt100

Rust linting configured (malachite-base/rustfmt.toml).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Cargo.toml).

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)
  • 38
    Forks
  • 43
    Releaseslatest 3y ago

Community

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

Responsiveness

  • 13h
    Median issue response
  • 1d 23h
    Median PR merge time
  • 6
    Open issues
Repository files29 root entries
  • .github
    Good: CI is configured (.github/workflows/rust.yml).
  • .vscode
  • docs
  • malachite
  • malachite-base
    Good: Test files detected (malachite-base/tests).
    Good: Rust linting configured (malachite-base/rustfmt.toml).
  • malachite-bigint
  • malachite-criterion-bench
  • malachite-float
  • malachite-nz
  • malachite-q
  • wip
  • _config.yml
  • .envrc
  • .gitignore
    Good: .gitignore present.
  • additional-lints.py
  • build.sh
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • COPYING
  • COPYING.LESSER
  • find_replace.py
  • flake.lock
  • flake.nix
  • katex-header.html
  • LICENSE
    Good: Licensed under LGPL-3.0.
  • PORTING.md
  • 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.
    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.
    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.
  • rundoc.sh
  • superfmt.sh