robojackets/robocup-software

0

/ 100

Documentation42
Engineering82
Health100
C++190Apache-2.01d ago
Grade a repo

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

Georgia Tech RoboJackets Software for the RoboCup Small Size League

Documentation

42

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt28

README is present.

Contributing guide5pt84

Contributing guide is detailed and thorough.

License6pt100

Licensed under Apache-2.0.

Engineering

82

CI/CD14pt72

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

Tests18pt80

Test files detected (launch/test_motion.launch.py).

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

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)
  • 189
    Forks
  • 3
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 4d 16h
    Median issue response
  • <1h
    Median PR merge time
  • 7
    Open issues
Repository files29 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • ci
  • cmake
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • install
  • launch
    Good: Test files detected (launch/test_motion.launch.py).
  • logs
  • src
  • util
    Good: Environment pinned via util/docker/baseimage/Dockerfile.
  • .clang-format
  • .clang-tidy
  • .clangd
  • .cmake-format.py
  • .coveragerc
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • colcon_defaults.yaml
  • CONTRIBUTING.md
    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.
    Good: Contributing guide includes code examples.
  • Dockerfile.ci
  • Dockerfile.dev
  • LICENSE
    Good: Licensed under Apache-2.0.
  • makefile
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
  • source.bash