Agent Friendly Code
← back to leaderboard

mermaid-js/mermaidGitHub

https://github.com/mermaid-js/mermaid
Stars:
90.6k
Language:
TypeScript
Default branch:
develop
Last scored:
15h ago
Overall

At a glance

Rank
#72 of 371
Top 19% · #17 of 81 TypeScript repos
Checks passed
10 of 16
Full list below
Best set up for
Devin
Score 88.3
Needs most work for
Cursor
Biggest fix: Cursor rules (.cursor/rules) (+12.0 pts)

What it has

What it's missing

What to fix first

  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
    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).
    +8.0 pts
  3. 3
    Manageable size
    If possible, split into smaller modules or carve out a focused entry path. Document where to start in AGENTS.md.
    +2.8 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
88.3
GPT-5 Codex
84.7
Claude Code
83.6
Kimi CLI
83.1
Pi
82.4
OpenHands
80.7
Aider
78.9
Gemini CLI
77.8
Cursor
75.9

Similar repos

Scored for Gemini CLI. Same language and host as this repo, scoring near it.

All TypeScript 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
24 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
package.json
Reproducible dev env· 100% pass
2 env artifacts (Dockerfile, docker-compose.yml)
Dockerfile
GEMINI.md· 0% pass
No GEMINI.md at repo root
License file· 100% pass
License present
LICENSE
Linter / formatter config· 100% pass
Config detected
eslint.config.js
.openhands/setup.sh· 0% pass
No .openhands/setup.sh
Pre-commit / git hooks· 100% pass
Hook framework configured
.husky
README· 100% pass
README detailed (24956 chars)
README.md
Manageable size· 50% pass
3990 files — large
Test suite· 100% pass
Found /tests
tests
Type configuration· 100% pass
Type config present
tsconfig.json

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/mermaid-js/mermaid
[![Agent Friendly](https://agentfriendlycode.com/api/badge/github/mermaid-js/mermaid.svg)](https://agentfriendlycode.com/repo/github/mermaid-js/mermaid)

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: [develop]

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?