0
/ 100
A workable base with real gaps. Start with setup instructions 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 B (84).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 2README12pt
Show a quick-start snippet so contributors can see what using your project looks like.
- 3README12pt
Link to a deployed version, docs site, or demo video. Users want to see it running.
- 4README12pt
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
13
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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.
Engineering
85
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 (uv.lock). Installs are reproducible.
Test files detected (tests).
CI is configured (.github/workflows/ci.yml).
Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).
Project health
80
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 (pyproject.toml).
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- 14% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 0Watchers
Responsiveness
- -Median issue response
- <1hMedian PR merge time
- 0Open issues
Repository files10 root entries
- .githubGood: CI is configured (.github/workflows/ci.yml).
- data
- scripts
- src
- testsGood: Test files detected (tests).
- .gitignoreGood: .gitignore present.
- .python-versionGood: Environment pinned via .python-version.
- pyproject.tomlGood: Dependency manifest found (pyproject.toml).
- README.mdGood: 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.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.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.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.
- uv.lockGood: Lockfile present (uv.lock). Installs are reproducible.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/ja-gilbert/macroswap)