Fresh project. Add a README and CI early.
Documentation
15
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
22
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.
No dependency lockfile found (−70 pts).
→ Commit go.sum so Go module downloads are repeatable.
Go module found but no *_test.go files detected.
→ Add *_test.go files alongside your packages and run `go test ./...`.
Formatting enforced (gofmt (built into Go toolchain)).
Project health
73
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.
.gitignore present.
Actively maintained (pushed within 3 months).
Dependency manifest found (go.mod).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 0Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files10 root entries
- .ideaGood: .gitignore present.Issue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
- contracts
- domain
- repo
- usecases
- ANSWERS.md
- go.modGood: Dependency manifest found (go.mod).
- main.go
- 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.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.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.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.
- REVIEW.md