apolloauto/apollo

0

/ 100

Documentation90
Engineering62
Health88
C++26,679Apache-2.02mo ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

An open autonomous driving platform

Documentation

90

Contributing guide5pt80

Contributing guide is detailed and thorough.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

62

CI/CD14pt0

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.

Tests18pt80

Test files detected (cyber/class_loader/test).

Reproducibility6pt80

Lockfile present (modules/dreamview/frontend/yarn.lock). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

88

Housekeeping3pt60

.gitignore present.

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (modules/dreamview/frontend/package.json).

Repository metadata5pt100

Repository has a description.

Repository files37 root entries
  • .github
    Good: Issue or PR templates present.
  • .teamcity
  • collection
  • cyber
    Good: Test files detected (cyber/class_loader/test).
    Good: Environment pinned via cyber/doxy-docs/environment.yml.
  • docker
  • docs
  • modules
    Good: Lockfile present (modules/dreamview/frontend/yarn.lock). Installs are reproducible.
    Good: Dependency manifest found (modules/dreamview/frontend/package.json).
    Issue: Build artifacts or local files may be committed (modules/common_msgs/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • scripts
  • third_party
  • tools
  • .bazelignore
  • .bazelrc
  • .clang-format
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc.json
  • apollo.doxygen
  • apollo.sh
  • BUILD
  • ci.yml
  • CODE_OF_CONDUCT_cn.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • collect_pre.sh
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide explains how to run tests.
    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.
  • CPPLINT.cfg
  • env.json
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MANIFESTO.md
  • 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.
    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.
    Good: README documents how to run the project.
  • readthedocs.yml
  • RELEASE.md
  • tox.ini
  • version.json
  • WORKSPACE
  • WORKSPACE.source