twitter/the-algorithm
Grade a repo

0

/ 100

GradeF

Huge star count, but README, tests, and CI need real investment.

Higher than 33% of 5,156 graded repos

Source code for the X Recommendation Algorithm

Documentation51
Engineering31
Health84
Scala73,450AGPL-3.011mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to D (68).

See your top fixes
Now
F
47
Potential
D
68

Top fixes

Highest-impact changes first, ranked by point weight

15 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
    CI/CD14pt

    If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

  3. 3
    README12pt

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

  4. 4
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

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

51

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt75

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

31

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

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.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt10

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 (unified_user_actions/adapter/src/test).

Project health

84

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Dependency manifest6pt100

Dependency manifest found (navi/dr_transform/Cargo.toml).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files30 root entries
  • ann
    Good: Environment pinned via ann/src/main/python/dataflow/worker_harness/Dockerfile.
  • ci
  • cr-mixer
  • docs
  • follow-recommendations-service
  • graph-feature-service
  • home-mixer
  • navi
    Good: Dependency manifest found (navi/dr_transform/Cargo.toml).
  • product-mixer
  • pushservice
  • recos-injector
  • representation-manager
  • representation-scorer
  • science
  • simclusters-ann
  • src
  • timelineranker
  • timelines
  • topic-social-proof
  • trust_and_safety_models
  • tweet-mixer
  • tweetypie
  • twml
  • unified_user_actions
    Good: Test files detected (unified_user_actions/adapter/src/test).
  • user-signal-service
  • visibilitylib
  • .gitignore
    Good: .gitignore present.
  • COPYING
  • 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.
    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.
  • RETREIVAL_SIGNALS.md
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/twitter/the-algorithm)](https://www.repo-grade.com/report/twitter/the-algorithm)

More graded Scala repos