stadiamaps/ferrostar

0

/ 100

Documentation63
Engineering76
Health100
Kotlin386Other1d ago
Grade a repo

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

A FOSS navigation SDK built from the ground up for the future

Documentation

63

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt47

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.

README12pt65

README is present.

License6pt100

Licensed under Other.

Engineering

76

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 (android/car-app/src/androidTest/java/com/stadiamaps/ferrostar/car/app/ExampleInstrumentedTest.kt).

CI/CD14pt85

CI is configured (.github/workflows/cargo-publish.yml).

Linting and formatting5pt100

Java/Kotlin linting configured (.editorconfig).

Reproducibility6pt100

Lockfile present (common/Cargo.lock). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Package.swift).

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)
  • 73
    Forks
  • 104
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 104d 12h
    Median issue response
  • 23h
    Median PR merge time
  • 146
    Open issues
Repository files28 root entries
  • .githooks
  • .github
    Good: CI is configured (.github/workflows/cargo-publish.yml).
    Good: Dependabot covers 4 ecosystems (cargo, swift, gradle, npm). Dependencies stay current.
  • .swiftpm
  • android
    Good: Test files detected (android/car-app/src/androidTest/java/com/stadiamaps/ferrostar/car/app/ExampleInstrumentedTest.kt).
  • apple
  • common
    Good: Lockfile present (common/Cargo.lock). Installs are reproducible.
  • guide
  • react-native
    Good: Environment pinned via react-native/.nvmrc.
  • scripts
  • web
  • _typos.toml
  • .editorconfig
    Good: Java/Kotlin linting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .spi.yml
  • .swiftformat
  • .swiftlint.yml
  • AGENTS.md
  • CLAUDE.md
  • CONTRIBUTING.md
    Issue: 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.
  • justfile
  • LICENSE.txt
    Good: Licensed under Other.
  • Package.resolved
  • Package.swift
    Good: Dependency manifest found (Package.swift).
  • README.md
    Good: 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.
    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.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • RELEASE.md
  • screenshot-android.png
  • screenshot.png