quantum-accelerators/quacc
Grade a repo

93

/ 100

GradeA

Polished and well engineered. Punching above its star count.

Top 8% of 5,156 graded repos

quacc is a flexible platform for computational materials science and quantum chemistry that is built for the big data era.

Documentation88
Engineering94
Health100
Python269BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

6 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

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

88

Contributing guide5pt77

CONTRIBUTING guide found.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

94

CI/CD14pt85

CI is configured (.github/workflows/tests.yaml).

Reproducibility6pt90

Lockfile present (tests/requirements.txt). Installs are reproducible.

Tests18pt100

Test files detected (tests).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.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)
  • 74
    Forks
  • 140
    Releaseslatest 3y ago

Community

  • 75% - Good
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 269
    Watchers

Responsiveness

  • 1d 6h
    Median issue response
  • <1h
    Median PR merge time
  • 35
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yaml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • docs
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
  • src
  • tests
    Good: Test files detected (tests).
    Good: Lockfile present (tests/requirements.txt). Installs are reproducible.
  • _zensical.toml
  • .codecov.yml
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • CHANGELOG.md
  • CITATION.cff
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • LICENSE.md
    Good: Licensed under BSD-3-Clause.
  • MANIFEST.in
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
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/quantum-accelerators/quacc)](https://www.repo-grade.com/report/quantum-accelerators/quacc)

More graded Python repos