bvlc/caffe
Grade a repo

0

/ 100

GradeC

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

Top 35% of 5,156 graded repos

Caffe: a fast open framework for deep learning.

Documentation74
Engineering80
Health79
C++34,572Other2y ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  3. 3
    Install and run instructions9pt

    Add a section showing how to start or use the project.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

74

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt67

Contributing guide is detailed and thorough.

README12pt85

README is present.

License6pt100

Licensed under Other.

Engineering

80

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Tests18pt80

Test files detected (include/caffe/test).

Reproducibility6pt80

Lockfile present (examples/web_demo/requirements.txt). Installs are reproducible.

CI/CD14pt100

CI is configured (.travis.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

79

Activity5pt20

No pushes in over a year (−80 pts).

→ A recent commit signals the project is alive and worth contributing to.

Dependency manifest6pt100

Dependency manifest found (examples/web_demo/requirements.txt).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files25 root entries
  • .github
    Good: Issue or PR templates present.
  • cmake
  • data
  • docker
    Good: Environment pinned via docker/cpu/Dockerfile.
  • docs
  • examples
    Good: Lockfile present (examples/web_demo/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (examples/web_demo/requirements.txt).
  • include
    Good: Test files detected (include/caffe/test).
  • matlab
  • models
  • python
  • scripts
  • src
  • tools
  • .Doxyfile
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • caffe.cloc
  • CMakeLists.txt
  • 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.
    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.
  • CONTRIBUTORS.md
  • INSTALL.md
  • LICENSE
    Good: Licensed under Other.
  • Makefile
  • Makefile.config.example
  • README.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.
    Good: README includes status badges.
    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.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/bvlc/caffe)](https://www.repo-grade.com/report/bvlc/caffe)

More graded C++ repos