Some interest. A stronger README and CI would help.
Documentation
63
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 documents how to install the project.
README is present.
Engineering
20
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 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 (backend/bgutil_server/package-lock.json). Installs are reproducible.
Linter or formatter configured (backend/bgutil_server/.prettierrc.json).
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 (backend/bgutil_server/package.json).
Actively maintained (pushed within the last month).
.gitignore present.
Repository files11 root entries
- backendGood: Linter or formatter configured (backend/bgutil_server/.prettierrc.json).Good: Lockfile present (backend/bgutil_server/package-lock.json). Installs are reproducible.Good: Environment pinned via backend/bgutil_server/Dockerfile.Good: Dependency manifest found (backend/bgutil_server/package.json).
- docs
- frontend
- .gitignoreGood: .gitignore present.
- CHANGELOG.md
- DEVELOPMENT.md
- PRIVACY.md
- README.mdGood: 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.
- ROADMAP.md
- TECHNICAL_SPECS.md
- TERMS.md