agentleFS
shangyiyshangyiy/life-kit/AGENTS.md

life-kit

AGENTS.md10 starsChanged 6 days agoMITView on GitHub

Write user-facing prose by the readable rule: one plain idea per point. Ship by verify-before-ship: someone who did not build the work checks the exact version that ships, then the owner approves, or rule 8 lets it merge. For skills, also follow agent-evals: score over repeated trials; grade the work, not its fit to the skill. Skills follow the two layers in README.md. Agents in agents/ only combine skills: each names the skills it applies and in what order. A…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    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:

    Write user-facing prose by the readable rule: one plain idea per point.

    line 1
  2. Distinctive:

    Every new or changed skill folder has a README.md that credits the sources the skill draws on: books, papers, published articles, talks and …

    line 10
  3. Very specific:

    Write "authors or speakers" when a talk or video is credited.

    line 15
  4. Very specific:

    Branch: never push to main. Use <type>/<topic> (feat, fix, docs, refactor, chore) and conventional commits.

    line 21
  5. Very specific:

    Leak audit: no private data, rubric or expected-answer wording in the diff.

    line 40

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

Write user-facing prose by the readable rule: one plain idea per point. Ship by verify-before-ship: someone who did not build the work checks the exact version that ships, then the owner approves, or rule 8 lets it merge. For skills, also follow agent-evals: score over repeated trials; grade the work, not its fit to the skill.

Skills follow the two layers in README.md. Agents in agents/ only combine skills: each names the skills it applies and in what order. A rule an agent needs goes in a skill, never in the agent. Repo and harness detail lives here or in skill-evals, never in a skill.

Every new or changed skill folder has a README.md that credits the sources the skill draws on: books, papers, published articles, talks and videos. Give literature as author, title, venue, year, and talks and videos as speaker, title, channel or venue, date, URL. End with: "This skill is an independent restatement. It is not affiliated with or endorsed by any of these authors." Write "authors or speakers" when a talk or video is credited. Omit the Credit section when there is nothing to credit. A core SKILL.md holds principles and definitions only: no examples, no source notes.

Shipping

  1. Branch: never push to main. Use <type>/<topic> (feat, fix, docs, refactor, chore) and conventional commits.
  2. Scope: one skill per PR, or one mechanical edit across skills; nothing unrelated. List new skills in README.md and both skills arrays.
  3. Version: bump only when shipped skill content changes (minor for a new skill, patch for a fix), in plugin.json, .claude-plugin/plugin.json and .claude-plugin/marketplace.json together.
  4. Evals: eval cases go only in their own draft PR to skill-evals/eval-sets/<skill>/. No eval material (cases, rubrics, expected answers) goes in the life-kit PR or in a skill folder.
  5. Checks: for a skill, run the closed-book eval (see the skill-evals README) and an independent agent review against this file. Every claim credited to a source must trace to it. For a new or changed skill or agent, also do a dry run: run the head version on real inputs (such as past cases with known right outputs) and judge the output's quality. A structural or wording review does not replace it. On every PR, run a review that every line is needed (such as /ponytail-review) on the diff and the PR body. Apply the right findings. In the PR body, explain any flagged text you keep. Before a PR is opened or updated, run every check that can run on its head sha.
  6. Leak audit: no private data, rubric or expected-answer wording in the diff. For a skill-evals PR, check private data only (eval wording is its content). No AI, programming-language, framework, tool or vendor terms (LLM, agent, git, ponytail, CI…) in a core skill's files, except names, titles, channels and URLs in README credits (case-insensitive, whole-word).
  7. PR body: shorter than the diff: Motivation (the problem in one or two sentences), Summary, Test evidence (each check, such as the eval, reviews and leak audit, with its method, result and head sha, or "could not run" and why), and Dependencies (linked PRs, or "none").
  8. Merge: open PRs as drafts and send Shang Yi the link. Merge only when every check passed on the final head sha. Any edit means running every check again. A check that could not run blocks the merge until Shang Yi decides. skill-evals PRs may be merged once an independent review and the leak audit pass on the final head sha. Small life-kit fixes (wording or a bug, no rule change) may be merged once a review by someone other than the author passes on the final head sha. New skills, rule or principle changes, and anything else or anything you are unsure about wait for Shang Yi's explicit OK.

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.