agentleFS
mrinalwadhwamrinalwadhwa/fluent/AGENTS.md

fluent

AGENTS.md125 starsChanged 12 days agoApache-2.0View on GitHub

These instructions define how Coding Agents should assist with this project. Use the fluent to build the fluent. For non-trivial code, documentation, skill, expertise, or behavior changes, follow the fluent skill and go through the Fluent lifecycle: brief, behaviors, approach, plan, execution, review, and land. Do not implement substantial product/code changes directly on main. Use Fluent Work Items and Attempts for delegated build work that needs isolation, reviewers, and merging. The Work model path is: Work Item, Attempt, Task, Workspace,…

  • Installs packages
  • 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,774 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.

  • In this repository6 other files it gives its agents.

The file

Show its rules and text

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

25 rules. About 0 are common, 17 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈17

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use the fluent to build the fluent.

    line 7
  2. Very specific:

    Do not implement substantial product/code changes directly on main.

    line 12
  3. Very specific:

    Use Fluent Work Items and Attempts for delegated build work that needs isolation, reviewers, and merging.

    line 13
  4. Distinctive:

    Do not meddle with live execution state directly: branches, worktrees, statuses, session artifacts, and merging state belong to the …

    line 23
  5. Distinctive:

    Keep main available as a stable integration branch for Work to rebase from and merge into.

    line 27
  6. Very specific:

    Use fluent observations add to record future work and lessons.

    line 31
  7. Distinctive:

    Use imperative mood and active voice

    line 40
  8. Distinctive:

    Start with a verb: "Add", "Fix", "Update", "Remove", "Refactor"

    line 41
  9. Distinctive:

    Do not end with a period

    line 44
  10. Distinctive:

    Use "Improve" over "Fix" when the change enhances something that was working but could be better.

    line 49
  11. Distinctive:

    Use bullet points (- prefix) for listing changes

    line 54
  12. Distinctive:

    Do not reference the process: no "from review run," "based on reviewer feedback," or "as part of run X"

    line 57
  13. Distinctive:

    Do not add Co-Authored-By trailers

    line 61
  14. Very specific:

    Do not reference run IDs, review artifacts, or fluent internals

    line 62
  15. Distinctive:

    Do not include counts or statistics: "fix 12 issues," "remove 3,000 lines," "update 47 files." The diff shows the numbers.

    line 63
  16. Distinctive:

    If the fast-forward fails, rebase the branch again and retry

    line 73
  17. Very specific:

    When asked to install the local Fluent binary, build the release binary and install it to the PATH-preferred user location:

    line 77
  18. Very specific:

    Do not use cargo install --path .

    line 86
  19. Distinctive:

    Don't create too many summary documents and markdown files.

    line 92
  20. Distinctive:

    Start with plain language.

    line 96
  21. Very specific:

    Avoid inventing names or metaphors for concepts that already have a clear description.

    line 99
  22. Distinctive:

    Before asking the user for a decision or explaining a recommendation, make the message self-contained.

    line 105
  23. Distinctive:

    When writing comments, docstrings, commit messages, or documentation, prefer active verb phrases over

    line 112
  24. Distinctive:

    When describing what a module or function does, prefer infinitive phrases:

    line 131
  25. Distinctive:

    If you can ask "Who does what?" and rewrite to answer that question with a subject and verb, use the active form.

    line 155

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

Instructions for Coding Agents

These instructions define how Coding Agents should assist with this project.

Fluent workflow

Use the fluent to build the fluent. For non-trivial code, documentation, skill, expertise, or behavior changes, follow the fluent skill and go through the Fluent lifecycle: brief, behaviors, approach, plan, execution, review, and land.

Do not implement substantial product/code changes directly on main. Use Fluent Work Items and Attempts for delegated build work that needs isolation, reviewers, and merging. The Work model path is: Work Item, Attempt, Task, Workspace, and Merge Candidate.

Conversation agents may edit Fluent planning and memory state directly when they are collaborating with the user in the discussion loop: observations, briefs, behavior drafts, approaches, plans, lightweight curation, and similar durable notes. These edits are part of shaping work, not delegated execution.

Do not meddle with live execution state directly: branches, worktrees, statuses, session artifacts, and merging state belong to the execution system. Modify them only during explicit recovery with the user.

Keep main available as a stable integration branch for Work to rebase from and merge into. If conversation-state edits could overlap with active Work or merging, make them on a lightweight discussion branch or worktree and land them separately instead of dirtying main. Use fluent observations add to record future work and lessons. Open observations live as one file per entry under .fluent/observations/; resolved ones move to .fluent/observations/resolved/. Inspect with fluent observations list and fluent observations show <id>.

Commit messages

Subject line

  • Use imperative mood and active voice
  • Start with a verb: "Add", "Fix", "Update", "Remove", "Refactor"
  • Keep under 50 characters
  • Capitalize the first letter
  • Do not end with a period
  • Describe the change, not the process that led to it
    • Good: "Fix sandbox worktree binding"
    • Bad: "Run review and fix issues found"
    • Bad: "Address reviewer findings"
  • Use "Improve" over "Fix" when the change enhances something that was working but could be better. "Fix" implies it was broken.

Body

  • Separate from the subject with a blank line
  • Use bullet points (- prefix) for listing changes
  • Wrap at 72 characters
  • Explain what changed and why, not how
  • Do not reference the process: no "from review run," "based on reviewer feedback," or "as part of run X"

Prohibited

  • Do not add Co-Authored-By trailers
  • Do not reference run IDs, review artifacts, or fluent internals
  • Do not include counts or statistics: "fix 12 issues," "remove 3,000 lines," "update 47 files." The diff shows the numbers. The message describes the change.

Linear history

Maintain a linear commit history — never create merge commits.

  • Rebase feature branches onto main before merging: git rebase main
  • Fast-forward merge only: git merge --ff-only <branch>
  • If the fast-forward fails, rebase the branch again and retry

Installing Fluent

When asked to install the local Fluent binary, build the release binary and install it to the PATH-preferred user location:

cargo build --release
install -m 0755 target/release/fluent /Users/mrinal/.local/bin/fluent
fluent version

Do not use cargo install --path . for this repository unless the user explicitly asks for it; that installs to Cargo's bin directory, while this environment resolves /Users/mrinal/.local/bin/fluent first.

Documentation

  • Don't create too many summary documents and markdown files.

Use clear, self-contained language

Start with plain language. Use established programming terms when they make the explanation more precise, and define them when the reader may not know them.

Avoid inventing names or metaphors for concepts that already have a clear description. Use existing project terminology consistently. When a Fluent-specific term is necessary, explain it in one short sentence before using it. Prefer “the current blocker and next safe action” over undefined shorthand such as “frontier.”

Before asking the user for a decision or explaining a recommendation, make the message self-contained. State the goal, relevant earlier decisions, current state, important evidence, the blocker or tradeoff, and the exact question or next step. Do not assume the user remembers earlier messages.

Use active verb forms

When writing comments, docstrings, commit messages, or documentation, prefer active verb phrases over nominalized noun phrases.

Active verbs are clearer, more direct, and easier to scan. They specify who or what performs the action and reduce ambiguity.

Examples

Avoid (nominalized)Prefer (active)
User authentication handlingAuthenticate users
WebSocket connection managementManage WebSocket connections
Error logging and reportingLog and report errors
Data validationValidate data
Cache invalidationInvalidate cache
Request processingProcess requests

Prefer "to + verb" over "for + gerund"

When describing what a module or function does, prefer infinitive phrases:

AvoidPrefer
"provides functions for extracting audio""provides functions to extract audio"
"for downloading and uploading files""to download and upload files"
"for managing webhooks""to manage webhooks"

Where this applies

  • Function and method docstrings
  • TODO comments
  • Commit messages
  • PR descriptions
  • README sections
  • Inline comments explaining intent

Exceptions

Nominalized forms are acceptable for class names (ConnectionManager, RequestHandler), module names, category labels in structured docs, and domain terms where the noun form is canonical.

Quick test

If you can ask "Who does what?" and rewrite to answer that question with a subject and verb, use the active form.

Interactive commands

Some git commands open an interactive pager that blocks terminal execution. Always pipe output to prevent blocking:

# Use these patterns to avoid blocking
git log --oneline -10 | cat
git diff | cat
git diff --stat | cat
git show | cat
git branch -a | cat

# Or use --no-pager flag
git --no-pager log --oneline -10
git --no-pager diff

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.