lukeprior/nbn-upgrade-map

0

/ 100

Documentation82
Engineering66
Health100
Python216MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Interactive map showing premises eligible for the NBN FTTP upgrade program.

Documentation

82

Contributing guide5pt0

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

66

Linting and formatting5pt0

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.

Issue and PR templates6pt0

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.

Tests18pt80

Test files detected (tests).

CI/CD14pt85

CI is configured (.github/workflows/main.yml).

Reproducibility6pt100

Lockfile present (code/requirements.txt). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (code/requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 26
    Forks
  • 47
    Releaseslatest 8mo ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 216
    Watchers

Responsiveness

  • 3h
    Median issue response
  • <1h
    Median PR merge time
  • 47
    Open issues
Repository files13 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
  • code
    Good: Lockfile present (code/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (code/requirements.txt).
  • extra
    Good: Environment pinned via extra/db/Dockerfile.
  • resources
  • results
  • site
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .htmlhintrc
  • .mega-linter.yml
  • CNAME
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: 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.