phonopy/phono3py
Grade a repo

77

/ 100

GradeC

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

Top 36% of 5,156 graded repos

A simulation package of phonon-phonon interaction related properties

Documentation82
Engineering66
Health100
Python164BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

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

  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

82

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under BSD-3-Clause.

Engineering

66

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.

Tests18pt80

Test files detected (test).

CI/CD14pt85

CI is configured (.github/workflows/phono3py-pytest-conda-macos.yml).

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

  • 18 / 157
    Commits (30d / 90d)
  • 68
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 2h
    Median issue response
  • 2h
    Median PR merge time
  • 7
    Open issues
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/phono3py-pytest-conda-macos.yml).
    Good: Issue or PR templates present.
  • c
  • doc
  • example
  • phono3py
  • test
    Good: Test files detected (test).
  • .clang-format
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • cmake-format.py
  • CMakeLists.txt
  • LICENSE
    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.
    Good: README has code examples.
    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.
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/phonopy/phono3py)](https://www.repo-grade.com/report/phonopy/phono3py)

More graded Python repos