agentleFS
Sign inStart free
plotlyplotly/plotly.js/AGENTS.md

plotly.js

AGENTS.md18k starsChanged 5 months agoMITView on GitHub

Read this file first. It states the rules that apply to every task in this repository. The .agents/ folder holds the detail. This guide is for coding agents. Human contributors must read CONTRIBUTING.md and the pull request template instead. CONTRIBUTING.md, BUILDING.md, and draftlogs/README.md hold the authority on process. This folder adds agent-specific rules on top of them. If a detail disagrees, follow the repository document and tell the human about the conflict. One exception outranks that rule: where a document…

Adopted by

Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data

Week of Sep 13: 0 new projectsWeek of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projectsWeek of Oct 25: 0 new projectsWeek of Nov 1: 0 new projects
Sep 2026Oct 2026Nov 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 0 in all, so this is a hint, not a trend.

Who's talking about plotly/plotly.js

The biggest 5 of 80 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 80

Talked about on GitHub, Stack Overflow, YouTube, Hacker News and Bluesky (80 times).

On GitHub · 41

36 more on GitHub

On Stack Overflow · 30

25 more on Stack Overflow

On YouTube · 4

On Bluesky · 1

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

The file

We split this AGENTS.md into the rules it gives an agent

6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Read this file first. It states the rules that apply to every task in this repository.

    line 3
  2. Distinctive:

    Use TypeScript (when possible) for new files.

    line 12
  3. Distinctive:

    Use modern JavaScript syntax for new and updated code.

    line 13
  4. Very specific:

    Every pull request adds a file to draftlogs/, one per category of change

    line 14
  5. Very specific:

    Never edit dist/. Regenerate test/plot-schema.json and the generated types with npm run schema.

    line 15
  6. Distinctive:

    Write prose in Simplified Technical English.

    line 16

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent guide for plotly.js

Read this file first. It states the rules that apply to every task in this repository. The .agents/ folder holds the detail.

This guide is for coding agents. Human contributors must read CONTRIBUTING.md and the pull request template instead.

The short version

  1. Work from an issue. If no issue covers the change, open one and stop there. Never open a PR for an issue labeled with plotly-internal.
  2. A human reviews the code before it reaches a pull request. If you cannot see the rendered plot, do not open a pull request for a visual change.
  3. Backwards compatibility and API consistency come first. Reuse an existing attribute name or enum value before you invent one.
  4. Use TypeScript (when possible) for new files. Don't create new types if similar ones already exist in the repo.
  5. Use modern JavaScript syntax for new and updated code. Extend existing logic instead of adding a new helper.
  6. Every pull request adds a file to draftlogs/, one per category of change
  7. Never edit dist/. Regenerate test/plot-schema.json and the generated types with npm run schema.
  8. Write prose in Simplified Technical English. Cap instruction sentences at 20 words.
  9. Name the test suites your change affects. Let the human run the browser tests unless explicitly asked.
  10. Report what you actually ran. Never state that a test passed if you did not run it.
  11. Walk .agents/pr-checklist.md before you hand the work back, and answer every item

Documents

DocumentRead it when
.agents/boundaries.mdBefore any command that changes state outside the working tree.
.agents/workflow.mdYou plan a branch, a commit, a draftlog, or a pull request body.
.agents/code-style.mdYou edit any file under src/, lib/, test/, tasks/, or devtools/.
.agents/architecture.mdYou need to find the right file, or you touch the schema.
.agents/testing.mdYou add behavior, fix a bug, or change a mock.
.agents/build-and-tooling.mdYou need a local build, a type check, or generated output.
.agents/writing-style.mdYou write a comment, a draftlog, a commit message, or a PR body.
.agents/pr-checklist.mdYou believe the task is done.

When the rules conflict

CONTRIBUTING.md, BUILDING.md, and draftlogs/README.md hold the authority on process. This folder adds agent-specific rules on top of them. If a detail disagrees, follow the repository document and tell the human about the conflict.

One exception outranks that rule: where a document in .agents/ restricts what an agent can do, the restriction wins. The repository documents address a human contributor who can look at a plot, judge a baseline diff, and answer in a review thread. CONTRIBUTING.md tells contributors to generate baselines locally and commit them, for example, and .agents/testing.md forbids that for you. Follow the restriction and hand the step to a human.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free