facebookresearch/ocean

0

/ 100

Documentation86
Engineering62
Health100
C++780MIT1d ago
Grade a repo

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

Ocean is the in-house framework for Computer Vision (CV) and Augmented Reality (AR) applications at Meta. It is platform independent and is mainly implemented in C/C++.

Documentation

86

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

62

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.

CI/CD14pt40

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

Reproducibility6pt70

Lockfile present (build/python/requirements.txt). Installs are reproducible.

Tests18pt80

Test files detected (build/gradle/application/ocean/test).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (build/gradle/application/ocean/demo/base/console/android/app/build.gradle.kts).

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)
  • 90
    Forks
  • 3
    Releaseslatest 2mo ago

Community

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

Responsiveness

  • 6h
    Median issue response
  • <1h
    Median PR merge time
  • 12
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/build_and_deploy_website.yml).
    Good: Issue or PR templates present.
  • build
    Good: Test files detected (build/gradle/application/ocean/test).
    Good: Lockfile present (build/python/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (build/gradle/application/ocean/demo/base/console/android/app/build.gradle.kts).
  • doc
  • impl
  • res
  • website
  • .clang-format
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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).
    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.
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    Good: README documents how to run the project.