Getting some notice. Tests and CI would be the fastest wins.
Git scraping of the Nova Scotia Power Outage Map
Documentation
26
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
56
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 (go.sum). Installs are reproducible.
Test files detected (cmd/scrape-outages/main_test.go).
Formatting enforced (gofmt (built into Go toolchain)).
Project health
91
No .gitignore found (−60 pts).
→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.
Dependency manifest found (go.mod).
Repository has a description.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 1Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 11Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files6 root entries
- bin
- cmdGood: Test files detected (cmd/scrape-outages/main_test.go).
- data
- go.modGood: Dependency manifest found (go.mod).
- go.sumGood: Lockfile present (go.sum). Installs are reproducible.
- 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.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.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.