Getting noticed, but rough fundamentals could turn visitors away.
Mohanson's Blog
Documentation
45
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
9
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
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 linter or formatter config found.
→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.
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 (requirements.txt). Installs are reproducible.
Project health
100
Dependency manifest found (requirements.txt).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 118Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 411Watchers
Responsiveness
- 15hMedian issue response
- <1hMedian PR merge time
- 1Open issues
Repository files9 root entries
- custom_theme
- docs
- res
- .gitignoreGood: .gitignore present.
- LICENSEGood: Licensed under MIT.
- make.py
- mkdocs.yml
- README.mdGood: README is present.Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.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.Good: README links to a live demo or deployed app.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.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- requirements.txtGood: Lockfile present (requirements.txt). Installs are reproducible.Good: Dependency manifest found (requirements.txt).