Huge star count, but README, tests, and CI need real investment.
Source code for the X Recommendation Algorithm
Documentation
51
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under AGPL-3.0.
Engineering
31
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.
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.
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.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
Test files detected (unified_user_actions/adapter/src/test).
Project health
84
Last pushed 6-12 months ago (−60 pts).
→ A recent commit signals the project is still maintained.
Dependency manifest found (navi/dr_transform/Cargo.toml).
Repository has a description.
.gitignore present.
Repository files30 root entries
- annGood: Environment pinned via ann/src/main/python/dataflow/worker_harness/Dockerfile.
- ci
- cr-mixer
- docs
- follow-recommendations-service
- graph-feature-service
- home-mixer
- naviGood: 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_actionsGood: Test files detected (unified_user_actions/adapter/src/test).
- user-signal-service
- visibilitylib
- .gitignoreGood: .gitignore present.
- COPYING
- README.mdGood: 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