Agent Friendly Code
← back to leaderboard

facebookresearch/faissGitHub

https://github.com/facebookresearch/faiss
Stars:
41.1k
Language:
C++
Default branch:
main
Last scored:
6h ago
Overall

At a glance

Rank
#288 of 371
#13 of 18 C++ repos
Checks passed
7 of 16
Full list below
Best set up for
Devin
Score 64.7
Needs most work for
Cursor
Biggest fix: Cursor rules (.cursor/rules) (+12.0 pts)

What it has

  • CI configuration
  • CONTRIBUTING guide
  • Dependency manifest
  • License file
  • Linter / formatter config

What it's missing

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

What to fix first

  1. 1
    AGENTS.md / CLAUDE.md
    Add an AGENTS.md covering project goals, layout, setup commands, and conventions. Aim for 800+ chars of real guidance (not boilerplate).
    +13.2 pts
  2. 2
    Reproducible dev env
    Add a Makefile or devcontainer or Dockerfile so the agent can set up the project in one command.
    +11.8 pts
  3. 3
    Type configuration
    Add a type config (tsconfig.json for JS/TS, mypy.ini or pyrightconfig.json for Python). Rust/Go/JVM/Scala/Swift/C#/OCaml/Haskell/Zig are typed by default.
    +7.9 pts

Score for each AI agent

Each agent looks for different things in a repo, based on its own docs. Under each score are the three checks it cares about most.

Devin
64.7
GPT-5 Codex
62.7
Aider
62.3
Pi
62.0
OpenHands
61.0
Kimi CLI
60.8
Claude Code
60.5
Gemini CLI
56.8
Cursor
55.7

Similar repos

Scored for Claude Code. Same language and host as this repo, scoring near it.

All C++ repos →

All checks

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
11 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· 100% pass
Manifest present
pyproject.toml
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· 100% pass
Config detected
.clang-format
.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
1106 files
Test suite· 100% pass
Found /tests
tests
Type configuration· 0% pass
No type config found

Add a badge to your README

Paste this at the top of the README. It shows the score, and links back to this page.

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

Check the score on every pull request

Add this file to your repo. On each pull request, it posts one comment showing how the score changed and why. It runs in your own CI, with no outside server involved.

# .github/workflows/agent-friendly.yml
name: Agent-friendly score diff

on:
  pull_request:
    branches: [main]

permissions:
  contents: read
  pull-requests: write

jobs:
  score-diff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - uses: hsnice16/agent-friendly-action@v0
        with:
          agents-badge-token: ${{ secrets.AGENTS_BADGE_TOKEN }}

Add AGENTS_BADGE_TOKENto the repo's secrets to turn the comment on. Without it, the action does nothing. Where do I add it?