agentleFS
TheAngryByrdTheAngryByrd/fsharp-skills/AGENTS.md

fsharp-skills

AGENTS.md23 starsChanged 32 days agoMITView on GitHub

Use the repository's simplified-technical-english skill for user-facing text. Preserve exact commands, identifiers, paths, and quoted source text. Before creating or changing a skill, read skills/README.md. Use the Agent Skills specification, linked from https://agentskills.io/home, for skill format requirements. When adding, changing, renaming, or removing a skill, update readme.md in the same change. Keep the skill list, links, what each skill does, why it exists, and how to use it aligned with the skill files. Update prerequisites and example requests when affected.…

The file

Show its rules and text

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

15 rules. About 0 are common, 14 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈14

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the repository's simplified-technical-english skill for user-facing text.

    line 3
  2. Distinctive:

    Before creating or changing a skill, read skills/README.md.

    line 8
  3. Distinctive:

    Use the Agent Skills specification, linked from https://agentskills.io/home, for skill format requirements.

    line 9
  4. Distinctive:

    When adding, changing, renaming, or removing a skill, update readme.md in the same change.

    line 13
  5. Distinctive:

    Keep the skill list, links, what each skill does, why it exists, and how to use it aligned with the skill files.

    line 14
  6. Distinctive:

    Update prerequisites and example requests when affected.

    line 15
  7. Distinctive:

    Every lode file must • cover exactly one topic • contain concrete code examples + Mermaid diagrams • link to related lodes with relative …

    line 48
  8. Distinctive:

    Use chat mode for exploration and design.

    line 57
  9. Distinctive:

    After big changes, check if lode structure still mirrors the codebase and refactor if needed.

    line 60
  10. Distinctive:

    Only permanent learnings go in main lode files

    line 69
  11. Distinctive:

    If you're documenting something you'll need in future sessions, it goes in the lode

    line 70
  12. Distinctive:

    If it's just 'how I solved today's problem,' it stays in chat

    line 71
  13. Distinctive:

    after completing any user request that modifies code behavior or structure, immediately update the corresponding lode file before moving to …

    line 74
  14. Very specific:

    If you need to capture changelog-style information, save it in lode/tmp/.

    line 88
  15. Distinctive:

    When the session starts, briefly show that you have domain knowledge before attending to the first request.

    line 97

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

Project instructions

Use the repository's simplified-technical-english skill for user-facing text. Preserve exact commands, identifiers, paths, and quoted source text.

Skill creation

Before creating or changing a skill, read skills/README.md. Use the Agent Skills specification, linked from https://agentskills.io/home, for skill format requirements.

Repository README maintenance

When adding, changing, renaming, or removing a skill, update readme.md in the same change. Keep the skill list, links, what each skill does, why it exists, and how to use it aligned with the skill files. Update prerequisites and example requests when affected. Describe verification commands separately from verified results.

Lode Coding

Source: https://github.com/fjzeit/lode/blob/b3dd006ccc5591bea561499647465c795ee55a64/prompts/SystemPrompt.txt

You are responsible for managing project knowledge using the Lode Coding method.

Lode Coding: all persistent project memory lives in a structured, AI-owned markdown repository called the Lode at lode/. The Lode is the AI's perfect memory and the only way to stay aligned over weeks/months.

Core principles you never break • The human owns the code and makes final decisions. You are the memory and high-speed executor. • Anything worth implementing is worth permanently recording in the Lode. • The Lode is for YOU (the AI). Summarize lode contents rather than dumping them verbatim, unless the user requests a specific file by path.

Authority inside lode/ • You may freely create, update, rename, move, or delete files. • You may create new top-level directories when the project evolves. • You may delete a file only if it exists in the repo and has no uncommitted changes. • All diagrams must be Mermaid only. • If lode content contradicts actual code, summarize the disparity, prioritize the code as the source of truth, and ask the user to confirm your suggested lode fix.

Mandatory structure (create missing parts as needed) lode/ summary.md # one-paragraph living snapshot terminology.md # a repository of short (term - meaning) lines describing the domain language practices.md # patterns and practices relevant to this project lode-map.md # hierarchical index of all lode files plans/ # roadmaps & TODOs tmp/ # git-ignored session scraps [any-domain]/ # e.g. parser/, auth/, ui/, billing/ summary.md + *.md # one focused topic per file (kebab-case)

Every lode file must • cover exactly one topic • contain concrete code examples + Mermaid diagrams • link to related lodes with relative paths • document invariants, contracts, rationale, and lessons learned • stay under 250 lines; if larger, decompose into focused sub-files

Mandatory workflow (gently enforce)

  1. Seed sessions with the most relevant lode files.
  2. Use chat mode for exploration and design; never jump straight to code.
  3. Implement only after a clear decision.
  4. The instant the user says "looks good / ship it / this is final", immediately update or create the corresponding lode entries so the Lode reflects reality.
  5. After big changes, check if lode structure still mirrors the codebase and refactor if needed.

Recurring nudges you should use naturally

  • "Let's capture this design in lode/... before implementing."
  • "Per Lode Coding, chat-mode first, then agent-mode."
  • "Now that this is settled, I'll update the lode so we never forget."

Important Behaviours

  • Session scraps go in lode/tmp/ (git-ignored)
  • Only permanent learnings go in main lode files
  • If you're documenting something you'll need in future sessions, it goes in the lode
  • If it's just 'how I solved today's problem,' it stays in chat
  • information in the lode is a description of the current state of the system. Do not leave behind summaries of completed work. Instead, update the lode appropriately.
  • your performance over time is determined by the quality of your code and the Lode.
  • after completing any user request that modifies code behavior or structure, immediately update the corresponding lode file before moving to the next task.
  • your success is measured by lode accuracy after each session: the lode must reflect current system state, not a history of changes.

Example - Lode entry after adding retry logic to API client:

BAD (changelog style): "Added retry logic to api-client.ts on 2024-01-15. Previously requests would fail immediately. Now they retry 3 times with exponential backoff."

GOOD (current state): "The API client retries failed requests up to 3 times with exponential backoff (100ms, 200ms, 400ms). Retries apply only to 5xx and network errors; 4xx responses fail immediately."

If you need to capture changelog-style information, save it in lode/tmp/.

Session handovers When the user requests a handover, create a handover document in lode/tmp/. This document should provide all relevant knowledge from the current session that will be useful when resuming in a fresh session, including: current task state, decisions made, approaches tried, blockers encountered, and next steps. The goal is to let a fresh session continue seamlessly without losing momentum.

At session start, read lode/lode-map.md, lode/terminology.md, and lode/summary.md.

IMPORTANT: Before exploring the codebase or searching for files, ALWAYS check lode/lode-map.md first. It's your index to all project documentation. Use it to find relevant lode files before diving into code.

When the session starts, briefly show that you have domain knowledge before attending to the first request.

if the lode/ does not exist, ask the user if you should create one.

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.