agentleFS
hidekituxhidekitux/skills/AGENTS.md

skills

AGENTS.md0 starsChanged 2 months agoApache-2.0View on GitHub

- Publishable skills belong in skills/<category>/<skill-name>/. The repository also supports skills/<namespace>/<skill-name>/ for arbitrary namespaced discovery tests and compatible sources. - Put a technology skill, a catalog entry with kind: stack that gives one technology's conventions, build commands, and test commands, in skills/<technology-category>/develop-<technology>/, where the technology category is language, mobile, web, or game. A technology skill has no layer, no skill graph node, and no instruction inventory entry, and it creates no Issue, Pull Request, branch, or release. See docs/skill-layers.md. -…

The file

Show its rules and text

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

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

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 19

    Very specific

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

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

    After adding, removing, or recategorizing a skill in CATALOG.yml, run mise run generate:skill-lists to rewrite the generated skill list in …

    line 5
  2. Very specific:

    Keep LICENSE as the unmodified Apache-2.0 legal text and keep the repository copyright attribution in NOTICE.

    line 8
  3. Very specific:

    Keep SKILL.md concise. Put optional scripts, detailed references, and output assets in scripts/, references/, and assets/ below the skill …

    line 10
  4. Common:

    Do not put credentials, tokens, private URLs, or user data in the repository.

    line 13
  5. Very specific:

    Use mise as the project command entry point.

    line 14
  6. Very specific:

    Keep the repository's required tools and their pinned versions in mise.toml.

    line 15
  7. Very specific:

    Before publishing, run mise run validate:all from the repository root.

    line 16
  8. Very specific:

    Before publishing, align every catalog version with the release tag, commit the release contents, and run mise run verify:release -- vX.Y.Z.

    line 21
  9. Distinctive:

    Every publishable skill must begin each invocation by creating and maintaining a Todo List.

    line 25
  10. Distinctive:

    Keep exactly one item in progress.

    line 27
  11. Distinctive:

    Use the host's native Todo List or task-tracking capability when it is available.

    line 28
  12. Distinctive:

    Before handoff, complete or explicitly explain every remaining Todo List item.

    line 29
  13. Very specific:

    When skill-creator is available, invoke it before creating a new skill or making a substantial update to an existing one.

    line 33
  14. Very specific:

    Treat this repository as the explicit destination: initialize a new publishable skill below skills/, not in a local agent directory.

    line 37
  15. Very specific:

    Before authoring, collect concrete trigger examples, the intended output, non-goals, required tools or data, and a verification method.

    line 38
  16. Very specific:

    Follow skill-creator's initialization and validation workflow.

    line 40
  17. Very specific:

    Add scripts/, references/, and assets/ only when they are reusable.

    line 42
  18. Very specific:

    When bootstrapping a project, make mise the standard entry point.

    line 44
  19. Very specific:

    Keep the core behavior, output contract, and safety rules in the skill's SKILL.md.

    line 48
  20. Very specific:

    Put a host-specific capability note at skills/<category>/<skill-name>/references/hosts/<host>.md only when the difference changes …

    line 49
  21. Very specific:

    Use agents/openai.yaml only for Codex UI metadata.

    line 50
  22. Very specific:

    Do not put shared source in .codex/, .claude/, or .agents/.

    line 51
  23. Very specific:

    Use FSL for stateful workflow contracts such as review, validation, publishing, versioning, and deprecation.

    line 53
  24. Very specific:

    Write every artifact that stays in the repository in English: code comments, docs/, SKILL.md, commit message bodies, Issue and Pull Request …

    line 58

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

Repository guidance

  • Publishable skills belong in skills/<category>/<skill-name>/. The repository also supports skills/<namespace>/<skill-name>/ for arbitrary namespaced discovery tests and compatible sources.
  • Put a technology skill, a catalog entry with kind: stack that gives one technology's conventions, build commands, and test commands, in skills/<technology-category>/develop-<technology>/, where the technology category is language, mobile, web, or game. A technology skill has no layer, no skill graph node, and no instruction inventory entry, and it creates no Issue, Pull Request, branch, or release. See docs/skill-layers.md.
  • After adding, removing, or recategorizing a skill in CATALOG.yml, run mise run generate:skill-lists to rewrite the generated skill list in README.md, docs/skill-layers.md, and skills/README.md; check:repository fails while a list is stale.
  • Give every skill a SKILL.md with name and description frontmatter. The name must match its directory name.
  • License every published skill as Apache-2.0, the repository standard. Do not add a different license or a non-Apache dependency bundled with a published skill without explicit user approval. Development and CI tools are not bundled dependencies; keep them pinned in mise.toml, use them only for development or checks, and review their licenses when adding them.
  • Keep LICENSE as the unmodified Apache-2.0 legal text and keep the repository copyright attribution in NOTICE.
  • Set the NOTICE copyright owner from the repository owner's confirmed identity. Update the year only when new copyrightable material is added or materially updated; do not create annual-only copyright commits.
  • Keep SKILL.md concise. Put optional scripts, detailed references, and output assets in scripts/, references/, and assets/ below the skill root.
  • Keep every per-skill asset, a file that belongs to exactly one skill, below its skill root. The evaluation inputs are the one exception: scenarios live in evaluations/scenarios/<skill-name>/ and fixtures in evaluations/fixtures/<key>/. Installation copies the whole skill directory, so an evaluation input there would ship to every user and reach the agent under evaluation, which could then read a scenario's expectations. check-evaluation fails when a scenario directory, a scenario's skill field, or a cataloged skill loses that link.
  • Keep the source of a reference file that several skills share in shared/references/<name>. Each skill whose SKILL.md names references/<name> keeps a byte-identical copy at references/<name>, because installation copies only the skill directory. Edit the source, then copy it into each consumer; check-shared-references in check:repository fails on a drifted or missing copy and prints the cp command that repairs it, and fails on a copy that its SKILL.md never names, which must be named or removed.
  • Do not put credentials, tokens, private URLs, or user data in the repository.
  • Use mise as the project command entry point. Run supported-platform repository checks with mise run validate:all; do not document or automate a direct replacement command when a mise task exists.
  • Keep the repository's required tools and their pinned versions in mise.toml. Do not add a tool, a version, or a task unless this repository actually needs it.
  • Before publishing, run mise run validate:all from the repository root. It includes installation validation for Codex and Claude Code. When skill-creator is available, also run mise run validate:skill-creator as additional Codex-specific authoring evidence; it is not required to use a skill in Claude Code.
  • Before publishing, align every catalog version with the release tag, commit the release contents, and run mise run verify:release -- vX.Y.Z. Publish only the verified commit with gh skill publish --tag vX.Y.Z; never overwrite an existing release tag.

Todo List contract

  • Every publishable skill must begin each invocation by creating and maintaining a Todo List. For a one-step request, use one item; do not omit the list.
  • Represent the requested outcome as small, observable items. Include discovery or scope confirmation, implementation, validation, and handoff when they apply.
  • Keep exactly one item in progress. Mark an item complete only after its stated result or evidence exists; add, remove, or reorder items when the agreed scope changes.
  • Use the host's native Todo List or task-tracking capability when it is available. Otherwise, present and maintain an equivalent Markdown checklist in the conversation. The skill must not depend on a proprietary task tool.
  • Before handoff, complete or explicitly explain every remaining Todo List item. Keep the final report consistent with the list and the checks actually run.

Creating and updating skills

  • When skill-creator is available, invoke it before creating a new skill or making a substantial update to an existing one. In hosts where it is not available, use docs/skill-brief-template.md to collect the same design inputs, then run the repository validations.
  • Treat this repository as the explicit destination: initialize a new publishable skill below skills/, not in a local agent directory.
  • Before authoring, collect concrete trigger examples, the intended output, non-goals, required tools or data, and a verification method. Use docs/skill-brief-template.md when this information is not already present in the request.
  • Design every new or substantially updated skill to follow the Todo List contract above. Put its task-specific initial items and completion evidence in SKILL.md; do not rely only on this repository guidance being present at installation time.
  • Follow skill-creator's initialization and validation workflow. Use its init_skill.py for a new skill, its quick_validate.py for the skill-level check, and gh skill publish --dry-run for repository-level validation.
  • Generate agents/openai.yaml through skill-creator when creating a Codex-facing skill. Read its openai_yaml.md reference first and keep the generated UI metadata aligned with SKILL.md.
  • Add scripts/, references/, and assets/ only when they are reusable. Test every added script with a representative input.
  • Forward-test complex or high-impact skills with realistic requests that do not reveal the expected answer.
  • When bootstrapping a project, make mise the standard entry point. Define only the applicable format:all, lint:all, test:all, check:all, and verify:fsl tasks; check should compose the relevant validations.

Host compatibility

  • Keep the core behavior, output contract, and safety rules in the skill's SKILL.md; do not duplicate a complete skill per agent.
  • Put a host-specific capability note at skills/<category>/<skill-name>/references/hosts/<host>.md only when the difference changes execution, safety, or the output. State the capability, the preferred path, the fallback, and how to verify the result.
  • Use agents/openai.yaml only for Codex UI metadata. Put repository-level configuration examples and installation notes in hosts/codex/ or hosts/claude-code/; these directories are not publishable skills.
  • Do not put shared source in .codex/, .claude/, or .agents/. Those hidden directories are local installation state and are intentionally ignored.
  • Use FSL for stateful workflow contracts such as review, validation, publishing, versioning, and deprecation. Do not claim that FSL verifies the prose instructions in a SKILL.md.
  • Place a skill-owned FSL source file in skills/<category>/<skill-name>/specs/; expose it in the repository through a relative symbolic link at specs/<category>/<skill-name>/. Place only repository-owned or cross-skill FSL sources directly in specs/. Before authoring or changing one, obtain confirmation of a formalization memo for choices that affect behavior. Expose FSL validation through mise run verify:fsl after changes.

Writing quality

  • Write every artifact that stays in the repository in English: code comments, docs/, SKILL.md, commit message bodies, Issue and Pull Request bodies, and Pull Request review comments. Conversation with the user is not an artifact, and it is held in Japanese.
  • Name a thing in full on first mention and reuse that exact term for every later mention. Do not introduce a shortened or varied form without defining it.
  • Choose the plain word. Do not use an inflated style word, a Latinate padding word, or serves as where is fits.
  • Choose a word people actually use. A replacement nobody says aloud fails the rules in either language, and so does prose assembled from such words.
  • In Japanese prose, replace a katakana loanword or an inline English word when a common Japanese word says the same thing, and keep terms already established in the domain. Keep every identifier, command, and path in its original form.
  • Name one concept with one term in each language. Take the Japanese term for an English term this repository uses from docs/term-glossary.md, and decide a term the glossary omits by the test in docs/writing-style.md.
  • Make every sentence add a fact the reader did not have. Delete a sentence that loses nothing.
  • State a position and give its reason. Do not present two options and commit to neither.
  • Cite the file, command, or output behind every claim about the repository.
  • See docs/writing-style.md for the full rules. They sit in three parts: one for both languages, one for English, and one for Japanese. Read the shared part and the part for the language you are writing in.

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.