herizon1054/openpilot

0

/ 100

Documentation59
Engineering98
Health84
Python9MIT1d ago
Grade a repo

Solid engineering. The main gap is visibility.

Documentation

59

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt75

README is present.

Contributing guide5pt79

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

98

Reproducibility6pt80

Lockfile present (uv.lock). Installs are reproducible.

Tests18pt100

Test files detected (cereal/messaging/tests).

CI/CD14pt100

CI is configured (Jenkinsfile).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

84

Repository metadata5pt40

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 manifest6pt100

Dependency manifest found (pyproject.toml).

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)
  • 5
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files52 root entries
  • .github
    Good: Issue or PR templates present.
  • .vscode
  • cereal
    Good: Test files detected (cereal/messaging/tests).
  • common
  • docs
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • dragonpilot
  • msgq_repo
  • opendbc_repo
  • openpilot
  • panda
    Good: Environment pinned via panda/Dockerfile.
  • panda_tici
  • rednose_repo
  • release
  • scripts
  • selfdrive
  • site_scons
  • system
  • teleoprtc_repo
  • tinygrad_repo
  • tools
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .python-version
  • ALKA_DESIGN.md
  • CHANGELOGS.md
  • conftest.py
  • Dockerfile.openpilot
  • generate_settings.py
  • generate_settings.sh
  • git_src_commit
  • git_src_commit_date
  • Jenkinsfile
    Good: CI is configured (Jenkinsfile).
  • launch_chffrplus.sh
  • launch_env.sh
  • launch_openpilot.sh
  • LICENSE
    Good: Licensed under MIT.
  • LICENSE.md
  • msgq
  • opendbc
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README_EN.md
    Good: README is present.
    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.
    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.
  • README_OPENPILOT.md
  • README.md
  • rednose
  • RELEASES.md
  • SConstruct
  • SECURITY.md
    Good: Security policy present.
  • teleoprtc
  • tinygrad
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.
  • zensical.toml