Agent Friendly Code
← back to leaderboard

facebookresearch/faissGitHub

https://github.com/facebookresearch/faiss
Stars:
39.9k
Default branch:
main
Last scored:
7h ago
Overall

Strengths

  • CI configuration
  • CONTRIBUTING guide
  • License file
  • README
  • Test suite

Gaps

  • AGENTS.md / CLAUDE.md
  • .aider.conf.yml
  • Cursor rules (.cursor/rules)
  • Dependency manifest
  • Reproducible dev env

Suggestions to improve for a specific model

  1. 1
    GEMINI.md
    Add a GEMINI.md at the repo root covering project goals, layout, setup commands, and conventions. Aim for 800+ chars of real guidance (not boilerplate).
    +11.4 pts
  2. 2
    Type configuration
    Add a type config (tsconfig.json for JS/TS, mypy.ini or pyrightconfig.json for Python). Rust/Go are typed by default.
    +10.2 pts
  3. 3
    Dependency manifest
    Commit a proper manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) plus a lockfile.
    +9.1 pts

Per-model scores

Claude Code
Loads CLAUDE.md at the start of every conversation per Anthropic's memory docs, so AGENTS.md / CLAUDE.md and a fast test loop carry the most weight.
43.4
Cursor
Per Cursor's Rules docs, reads `.cursor/rules/*.mdc` and AGENTS.md as the canonical repo-side input. Type config and a clean README still aid the codebase index but aren't the docs-cited signal.
36.4
Devin
Operates from a sandboxed Ubuntu VM and runs an 8-step machine setup (deps, secrets, language versions, lint/test commands) per Cognition's repo-setup docs. CI config files alone aren't what the docs ask for — a runnable dev environment is.
46.5
GPT-5 Codex
Reads AGENTS.md before doing any work per OpenAI's Codex docs — the strictest AGENTS.md adherent of any agent here. Hierarchical (per-directory) AGENTS.md and AGENTS.override.md are first-class.
45.3
Gemini CLI
Reads hierarchical `GEMINI.md` (global → workspace → component-level) at every prompt per Gemini CLI's docs. The long-context advantage favors repos that split context per directory rather than docs-heavy in general.
39.8
Aider
Auto-lints on every edit by default; runs the configured test command after edits when `--test-cmd` is set (per Aider's lint/test docs). A green linter and a declared test command translate directly into successful commits.
36.8
OpenHands
Runs in a sandboxed container and executes `.openhands/setup.sh` at session start per OpenHands' repo-customization docs. Root AGENTS.md is now the preferred always-on instruction surface (microagents are deprecated in favor of it).
44.4
Pi
Minimal terminal coding harness. Loads `AGENTS.md` (or `CLAUDE.md`) at startup — global, parent dirs, then cwd — per the Pi coding-agent README. Sandboxing is deferred to user-installed extensions.
40.8

Alternatives

Same-language repos scored for Gemini CLI. Heuristic v1 (same language + same host); cross-language matches are refined in v0.6.0.

Signal breakdown

AGENTS.md / CLAUDE.md· 0% pass
No agent instructions file found
.aider.conf.yml· 0% pass
No .aider.conf.yml at repo root
CI configuration· 100% pass
9 GitHub Actions workflow(s)
.github/workflows
CONTRIBUTING guide· 100% pass
Guide present
CONTRIBUTING.md
Cursor rules (.cursor/rules)· 0% pass
No .cursor/rules/*.mdc or .cursorrules
Dependency manifest· 0% pass
No dependency manifest found
Reproducible dev env· 0% pass
No Makefile / devcontainer / Docker / equivalent found
GEMINI.md· 0% pass
No GEMINI.md at repo root
License file· 100% pass
License present
LICENSE
Linter / formatter config· 0% pass
No linter/formatter config found
.openhands/setup.sh· 0% pass
No .openhands/setup.sh
Pre-commit / git hooks· 0% pass
No pre-commit / husky / lefthook found
README· 100% pass
README detailed (6363 chars)
README.md
Manageable size· 80% pass
954 files
Test suite· 100% pass
Found /tests
tests
Type configuration· 0% pass
No type config found

Embed this badge

Drop the snippet below into the top of this repo's README so visitors can see its agent-friendliness at a glance — clicks land back here.

Agent friendly score for github/facebookresearch/faiss
[![Agent Friendly](https://agentfriendlycode.com/api/badge/github/facebookresearch/faiss.svg)](https://agentfriendlycode.com/repo/141)