agentleFS
gabrielSantosLimagabrielSantosLima/harness/skills/readme/SKILL.md

README

Skill1 starsChanged 8 days agoMITView on GitHub

Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.

38 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use favicon, build and 6 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • cpiprintSkill

    favicon

    Generate favicons from a source image

    Also in 3 projects that use this

  • Microsoft AzureSkill

    build

    Build the TypeSpec Rust emitter from source. Run this after cloning the repo, after pulling changes, or when TypeScript source files have been modified.

    Also in 3 projects that use this

  • GitHubSkill

    refactor

    Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.

    Also in 3 projects that use this

  • BlockSkill

    plan

    Draft a TDD, PRD, or lightweight plan in the conversation without committing it.

    Also in 3 projects that use this

  • GoogleSkill

    prototype

    Build a throwaway prototype to answer a design question. Use when the user wants to sanity-check whether a state model or logic feels right, or explore what a UI should look like.

    Also in 3 projects that use this

  • SentrySkill

    commit

    Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

16 rules. 0 are common, 13 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 38 edited versions we read keep these.

  • 13

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

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

    Write or restructure a README using the template in references/template.md.

    line 8
  2. Distinctive:

    Never infer features. Use what the repository and the user provide.

    line 23
  3. Distinctive:

    Ask in one round:

    line 27
  4. Distinctive:

    Do not add a section you cannot fill truthfully.

    line 38
  5. Very specific:

    Create README.pt-BR.md and/or README.es.md only when chosen.

    line 73
  6. Very specific:

    Keep the same language selector in every file, in this order: English | Português (Brasil) | Español

    line 77
  7. Distinctive:

    Do not translate badges, version numbers or brand names.

    line 79
  8. Distinctive:

    Read the current README before writing.

    line 83
  9. Distinctive:

    Keep useful commands, features and notes.

    line 84
  10. Distinctive:

    Do not delete content without explicit approval.

    line 85
  11. Distinctive:

    Every language link points to an existing file.

    line 93
  12. Distinctive:

    No secret, token, local path or agent attribution appears.

    line 95
  13. Distinctive:

    Never invent features, commands or screenshots.

    line 106
  14. Distinctive:

    Never add a language file without the matching selector entry.

    line 107
  15. Distinctive:

    Never overwrite unrelated sections without approval.

    line 108
  16. Distinctive:

    Never add AI attribution or tool mentions.

    line 109

“Common” is measured: kept by at least 6 in 10 of the 38 edited versions of this file we could read. “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

README

Write or restructure a README using the template in references/template.md. The English file is canonical; translations mirror its structure.

1. Inspect the repository

Collect:

  • existing README.md, README.pt-BR.md, README.es.md;
  • the license file and type;
  • logo candidates (assets/logo.png, assets/images/logo.png, icon.png, ...);
  • the project description from a manifest, if any;
  • the default branch and remote (git remote get-url origin);
  • existing workflows under .github/workflows/.

Never infer features. Use what the repository and the user provide.

2. Ask

Ask in one round:

  1. Languages: English only, English + Portuguese, English + Spanish, or all three. Default to the languages that already exist; if none, ask.
  2. Logo: none, or a path. Suggest a detected candidate.
  3. Badges: CI, Release, Docs, License. Default: Release and License, plus CI when ci.yml exists, plus Docs when a Pages workflow exists.
  4. Sections: Features, Requirements, Getting started, Usage, Configuration, Development, Testing, Releasing, Contributing, License. Default to the ones the repository can support with real content.

Do not add a section you cannot fill truthfully.

3. Resolve the metadata

  • owner/repo from the remote. Accept SSH and HTTPS URLs.
  • Project name from the user or the manifest. Use the display name, not the package slug.
  • One-line description from the user or the manifest.
  • License: use the file name (LICENSE) and the detected type (MIT, Apache-2.0, ...).

4. Write the English README

Follow references/template.md:

<div align="center">

<img src="<logo>" alt="<name>" width="200" />

# <name>

<description>

[badges]

[language selector]

</div>

Then the chosen sections.

5. Write translations

Create README.pt-BR.md and/or README.es.md only when chosen.

  • Mirror the section order and links.
  • Translate prose; keep commands, code, file names and URLs unchanged.
  • Keep the same language selector in every file, in this order: [English](README.md) | [Português (Brasil)](README.pt-BR.md) | [Español](README.es.md)
  • Do not translate badges, version numbers or brand names.

6. Preserve existing content

  • Read the current README before writing.
  • Keep useful commands, features and notes; move them into the new structure.
  • Do not delete content without explicit approval.
  • Show a diff before writing when a README already exists.

7. Validate

  • Title matches the project display name.
  • Badge URLs point to the real repository and existing workflows.
  • The license badge points to LICENSE.
  • Every language link points to an existing file.
  • Section headings are consistent across languages.
  • No secret, token, local path or agent attribution appears.
  • Relative links resolve.

8. Hand off

Report the files created or changed, the chosen languages, the badges, the sections included and anything the user must fill in. Do not commit, push or tag unless the user asks.

Boundaries

  • Never invent features, commands or screenshots.
  • Never add a language file without the matching selector entry.
  • Never overwrite unrelated sections without approval.
  • Never add AI attribution or tool mentions.

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.