autowarefoundation/autoware_core

0

/ 100

Documentation38
Engineering70
Health84
C++175Apache-2.01d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Documentation

38

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt30

README is present.

Contributing guide5pt52

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.

License6pt100

Licensed under Apache-2.0.

Engineering

70

Reproducibility6pt12

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

CI/CD14pt57

CI is configured (.github/workflows/build-and-test-daily.yaml).

Tests18pt80

Test files detected (api/autoware_adapi_adaptors/test).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc.yaml).

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 (setup.cfg).

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)
  • 141
    Forks
  • 15
    Releaseslatest 7mo ago

Community

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

Responsiveness

  • 15d
    Median issue response
  • <1h
    Median PR merge time
  • 87
    Open issues
Repository files44 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/build-and-test-daily.yaml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • api
    Good: Test files detected (api/autoware_adapi_adaptors/test).
  • autoware_core
  • common
  • control
  • description
  • doc
  • localization
  • map
  • perception
  • planning
  • sensing
  • testing
  • vehicle
  • .clang-format
  • .clang-tidy
  • .clang-tidy-ci
  • .clang-tidy-ignore
  • .cppcheck_suppressions
  • .cspell.json
  • .gitignore
    Good: .gitignore present.
  • .lcovrc
  • .markdown-link-check.json
  • .markdownlint.yaml
  • .pages
  • .pre-commit-config-optional.yaml
  • .pre-commit-config.yaml
  • .prettierignore
  • .prettierrc.yaml
    Good: Linter or formatter configured (.prettierrc.yaml).
  • .yamllint.yaml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yaml
  • 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.
  • CPPLINT.cfg
  • DISCLAIMER.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • mkdocs_macros.py
  • mkdocs.yaml
  • NOTICE
  • packages_above.repos
  • 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.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    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.
  • setup.cfg
    Good: Dependency manifest found (setup.cfg).
  • THIRD_PARTY_NOTICE