0
/ 100
Early-stage engineering. The fastest wins are CI and the README.
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (79).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 2README12pt
Expand with a description, install steps, usage, and examples.
- 3README12pt
Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
- 4README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
53
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.
README is present.
README documents how to install the project.
Licensed under MIT.
Engineering
45
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
No Rust linting or formatting enforced.
→ Add `cargo clippy -- -D warnings` and `cargo fmt --check` as CI steps, and optionally a rustfmt.toml for project-specific style rules.
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.
Lockfile present (Cargo.lock). Installs are reproducible.
Test files detected (tests).
Project health
84
No repository description set on GitHub (−60 pts).
→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.
Dependency manifest found (Cargo.toml).
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 312 / 482Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- 71% - FairCommunity health
- -authors own >50% of commits
- 0Watchers
Responsiveness
- -Median issue response
- <1hMedian PR merge time
- 0Open issues
Repository files38 root entries
- .dvcGood: .gitignore present.
- crates
- hexatic
- packages
- testsGood: Test files detected (tests).
- .dvcignore
- .gitattributes
- .gitignore
- .gitmodules
- .ignore
- AGENTS.md
- ARCHITECTURE.md
- Cargo.lockGood: Lockfile present (Cargo.lock). Installs are reproducible.
- Cargo.tomlGood: Dependency manifest found (Cargo.toml).
- claude_plan.md
- CLAUDE.md
- DISCLOSURE.md
- dump.py
- hoomd-blue
- INSTRUCTIONS.md
- LICENSEGood: Licensed under MIT.
- main_sim.sh
- MATH.md
- nohup.out
- output
- path.md
- pixi.lock
- pixi.toml
- PLAN.md
- radii_analysis.sh
- README.mdGood: 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.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.
- REPORT.md
- rust-toolchain.toml
- STEPS.md
- sync_radii_from_flock.sh
- sync_unwrapped_from_flock.sh
- temp.py
- TIME_COMPLEXITY.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/vaibhav-venkat/soft-material-research)