lirantallirantal/agent-rules/AGENTS.md

agent-rules

AGENTS.md65 starsChanged 16 months agoApache-2.0View on GitHub

Guidance for AI coding agents working in this repository. Before making changes, read: Treat those files as the source of truth. Do not duplicate or reinterpret their rules here.

4 other projects use a version of this.

Adopted by

Most recently taken up by

lirantal/npqword for word, first seen Oct 8, 2026
lirantal/tokenuword for word, first seen May 28, 2026
lirantal/ls-mcpword for word, first seen Jun 3, 2025
lirantal/mcp-server-nodejs-api-docsword for word, first seen May 25, 2025

Other versions4 projects use a version of this.
Word for word · 4
lirantal/npq★ 1.8k100% same
lirantal/ls-mcp★ 84100% same
lirantal/tokenu★ 67100% same
lirantal/mcp-server-nodejs-api-docs★ 11100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
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

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

≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Before making changes, read:
line 7
Distinctive:
Treat those files as the source of truth.
line 18
Distinctive:
Keep documentation in sync when changing behavior, public interfaces, workflows, architecture, configuration, or operational assumptions.
line 22
Very specific:
Put project-specific development details in docs/.
line 23
Distinctive:
Prefer linking to the source of truth over duplicating long instructions across files.
line 24
Very specific:
When adding new docs, link them from docs/README.md and update this file only when they become important entry points for future agents.
line 25
Very specific:
Follow PR, issue, and agent-labeling rules in CONTRIBUTING.md.
line 29
Very specific:
Use the issue-linking format specified in CONTRIBUTING.md.
line 30
Very specific:
Follow RELEASE.md for release workflow and changeset creation steps.
line 34
Very specific:
If this project uses changesets, treat RELEASE.md and any changeset guidance in CONTRIBUTING.md as authoritative.
line 35

≈ “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

Guidance for AI coding agents working in this repository.

Start Here

Before making changes, read:

CONTRIBUTING.md for contribution, PR, testing, commit, and agent-specific expectations.
RELEASE.md for release workflow details.
README.md for user-facing behavior, install/use examples, and package or app overview.
docs/README.md for the project documentation index.
docs/development.md for local setup and development workflows.
docs/testing.md for test strategy, commands, and verification expectations.
docs/architecture.md for project structure, boundaries, and important invariants.
docs/conventions.md for project-specific coding, documentation, and maintenance conventions.

Treat those files as the source of truth. Do not duplicate or reinterpret their rules here.

Documentation

Keep documentation in sync when changing behavior, public interfaces, workflows, architecture, configuration, or operational assumptions.
Put project-specific development details in docs/; keep root files focused on their standard audiences.
Prefer linking to the source of truth over duplicating long instructions across files.
When adding new docs, link them from docs/README.md and update this file only when they become important entry points for future agents.

PRs and Issues

Follow PR, issue, and agent-labeling rules in CONTRIBUTING.md.
Use the issue-linking format specified in CONTRIBUTING.md.

Releases

Follow RELEASE.md for release workflow and changeset creation steps.
If this project uses changesets, treat RELEASE.md and any changeset guidance in CONTRIBUTING.md as authoritative.

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