agentleFS
ronedgecombronedgecomb/anything/skills/repo-style/SKILL.md

repo-style

Skill1 starsChanged 9 days agoApache-2.0View on GitHub

Keep project structure and documentation clear, discoverable, and proportional to the work. Use when adding or organizing files, establishing repository conventions, or updating documentation for software, research, writing, and other projects. Prefer existing conventions and make structural changes only when they solve a concrete problem.

The file

Show its rules and text

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈16

    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:

    Follow the project's existing organization and the user's requested outcome.

    line 9
  2. Distinctive:

    Use the root README as a concise entry point when the project needs one: purpose, how to use the work, and where to go next.

    line 20
  3. Very specific:

    Add docs/ or topic directories when the material needs them.

    line 22
  4. Distinctive:

    Keep transient output distinct from durable source where useful, following the project's tracking and retention policy.

    line 23
  5. Distinctive:

    When no file operations are available, describe the intended structure or return the proposed content without claiming to have changed it.

    line 26
  6. Distinctive:

    Write for the intended reader in plain language.

    line 30
  7. Distinctive:

    Prefer short, concrete explanations and examples that match the real project.

    line 32
  8. Distinctive:

    Use headings, lists, and tables when they make information easier to find or compare.

    line 33
  9. Distinctive:

    Keep quick-start instructions focused on the usual path.

    line 34
  10. Distinctive:

    Document behavior, supported usage, and consequential trade-offs.

    line 35
  11. Distinctive:

    Verify commands, paths, and factual claims against accessible source material.

    line 36
  12. Distinctive:

    Update affected existing documentation when behavior changes.

    line 37
  13. Distinctive:

    Create a plan, decision record, changelog entry, or guide when requested or useful to its readers.

    line 38
  14. Distinctive:

    Keep sensitive material out of public documentation.

    line 42
  15. Distinctive:

    Use applicable project instructions, including AGENTS.md when available.

    line 46
  16. Distinctive:

    If preferences are absent, continue with these defaults.

    line 48
  17. Distinctive:

    Check the affected links, examples, structure, and relevant documentation tooling when available.

    line 50

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill 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
SKILL.md

Repository and documentation style

Follow the project's existing organization and the user's requested outcome. Use the defaults below for choices they leave open. A project need not contain code, Git, or a particular toolchain.

Inspect before organizing

Find the existing entry points, instruction files, source material, outputs, and documentation. Understand how people use them before adding another convention.

Preserve established names and structure when they work. Do not introduce a new architecture, directory taxonomy, build tool, or dependency just because this skill was loaded.

Structure defaults

  • Give important material an obvious home and a descriptive name.
  • Use the root README as a concise entry point when the project needs one: purpose, how to use the work, and where to go next.
  • Group implementation, source material, tests, assets, and generated results according to the project's language or domain. Do not impose src/, tests/, or any other directory on every project.
  • Add docs/ or topic directories when the material needs them. Keep a small project small.
  • Keep transient output distinct from durable source where useful, following the project's tracking and retention policy.
  • Maintain one authoritative explanation of each rule or decision. Link from other places instead of copying it.

When no file operations are available, describe the intended structure or return the proposed content without claiming to have changed it.

Documentation defaults

Write for the intended reader in plain language. Lead with the purpose or action, then add the context needed to use it.

  • Prefer short, concrete explanations and examples that match the real project.
  • Use headings, lists, and tables when they make information easier to find or compare.
  • Keep quick-start instructions focused on the usual path. Move substantial reference detail to a linked page when needed.
  • Document behavior, supported usage, and consequential trade-offs. Include internal mechanics only when they help the reader act.
  • Verify commands, paths, and factual claims against accessible source material. Label unverified examples and placeholders.
  • Update affected existing documentation when behavior changes. Remove stale instructions instead of adding a competing explanation.
  • Create a plan, decision record, changelog entry, or guide when requested or useful to its readers. Do not generate a set of ceremonial documents for every task.

When revising factual or technical prose, identify the details that must survive: names, numbers and units, commands, paths, links, conditions, trade-offs, established terminology, and uncertainty. Compare the edited text with the original and its sources. Preserve those details or explain factual corrections supported by evidence; clearer wording must preserve the claim's scope and necessary qualifiers. Match the depth of this check to the risk of changing the meaning; a separate inventory or report is optional.

Keep sensitive material out of public documentation. Use the project's normal configuration and secret-handling conventions.

Project preferences and verification

Use applicable project instructions, including AGENTS.md when available. Durable workflow choices belong in the existing instruction or policy location.

If preferences are absent, continue with these defaults. Do not invoke setup automatically or create a new instruction policy as an incidental formatting change. A user can explicitly request setup to establish or update those choices.

Check the affected links, examples, structure, and relevant documentation tooling when available. Match verification to the change; a small wording edit does not require a new test suite. Report the actual result and any meaningful uncertainty.

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.