facebook/fboss

0

/ 100

Documentation55
Engineering83
Health100
C++976Other1d ago
Grade a repo

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

Facebook Open Switching System Software for controlling network switches.

Documentation

55

README12pt35

README is present.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

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.

License6pt100

Licensed under Other.

Engineering

83

Reproducibility6pt22

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Tests18pt80

Test files detected (build/fbcode_builder/getdeps/test).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (ruff.toml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (docs/package.json).

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)
  • 397
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 12h
    Median issue response
  • <1h
    Median PR merge time
  • 164
    Open issues
Repository files27 root entries
  • .buckconfig.d
  • .github
    Good: CI is configured (.github/workflows/distro_image_build.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • build
    Good: Test files detected (build/fbcode_builder/getdeps/test).
  • cmake
  • common
  • configerator
  • docs
    Good: Dependency manifest found (docs/package.json).
  • fboss
  • fboss-image
    Good: Environment pinned via fboss-image/distro_cli/tests/proxy_device/Dockerfile.
  • neteng
  • .buckconfig
  • .clang-format
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • buck2
  • BUILD.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.
  • functions.cmake
  • getdeps.sh
  • LICENSE
    Good: Licensed under Other.
  • PATENTS
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Good: README documents how to run the project.
  • requirements-dev.txt
  • ruff.toml
    Good: Linter or formatter configured (ruff.toml).
  • sdk_dependencies.txt