Strong community interest, but docs and engineering haven't caught up to the hype.
Documentation
48
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.
→ Add setup instructions, code style notes, and how to run tests.
README is present.
Licensed under Other.
Engineering
66
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.
CI is configured (.github/workflows/run_tests.yml).
Lockfile present (docs/requirements.txt). Installs are reproducible.
Test files detected (tests).
Issue or PR templates present.
Project health
63
No pushes in over a year (−80 pts).
→ A recent commit signals the project is alive and worth contributing to.
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 (docs/requirements.txt).
.gitignore present.
Repository files16 root entries
- .githubGood: CI is configured (.github/workflows/run_tests.yml).Good: Issue or PR templates present.
- 3rdparty
- build
- docsGood: Lockfile present (docs/requirements.txt). Installs are reproducible.Good: Dependency manifest found (docs/requirements.txt).
- src
- testsGood: Test files detected (tests).
- .gitignoreGood: .gitignore present.
- .gitmodules
- .readthedocs.yaml
- BACKERS.md
- CONTRIBUTING.mdIssue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- COPYRIGHT
- LICENSEGood: Licensed under Other.
- mkdocs.yml
- 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 some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.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.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.
- sonar-project.properties