0xhokugava/quantum_lab
Grade a repo

0

/ 100

GradeC

Strong early engineering with some momentum.

Top 35% of 5,156 graded repos

Modular quantum computing simulator built with Rust.

Documentation74
Engineering77
Health89
Rust13GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

18 to address
  1. 1
    Tests18pt

    Add test/dev tooling under [dev-dependencies] so `cargo test` runs a complete suite.

  2. 2
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    README12pt

    Link to a deployed version, docs site, or demo video. Users want to see it running.

  4. 4
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

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

74

README12pt50

README is present.

Contributing guide5pt74

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

77

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.

Tests18pt80

Test files detected (tests).

CI/CD14pt100

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

Linting and formatting5pt100

Rust linting configured (cargo fmt in CI).

Project health

89

Dependency manifest6pt65

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

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 13
    Watchers

Responsiveness

  • 26d 19h
    Median issue response
  • <1h
    Median PR merge time
  • 5
    Open issues
Repository files12 root entries
  • .github
    Good: CI is configured (.github/workflows/rust.yml).
  • benches
  • docs
  • src
  • tests
    Good: Test files detected (tests).
  • validation
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under GPL-3.0.
  • 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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
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/0xhokugava/quantum_lab)](https://www.repo-grade.com/report/0xhokugava/quantum_lab)

More graded Rust repos