agentsclimarketplace
Sign in

Readme polish

Skill contextosai/skills/skills/readme-polish

Improve a project's README for clarity, structure, and completeness without changing its meaning. Use when the user asks to clean up, polish, or improve a README or project documentation.From its SKILL.md

Install
npx -y skills add contextosai/skills --skill readme-polish

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.3 KB, 243 tokens by cl100k_base, as published. Nobody here has run it

README Polish

Improve an existing README's clarity and structure while preserving its intent.

Steps

  1. Read the current README in full before changing anything.
  2. Check that it answers the questions a new reader asks, in order:
    • What is this project and who is it for?
    • How do I install it?
    • How do I use it (a minimal, copy-pasteable example)?
    • How do I configure it?
    • How do I contribute / where do I get help?
  3. Restructure and tighten the prose. Do not invent features, commands, or claims that aren't supported by the project.

Suggested structure

# Project Name
One-line description.

## Installation
## Usage
## Configuration
## Contributing
## License

Guidelines

  • Preserve technical accuracy above all — when unsure whether a command or claim is correct, flag it for the user instead of guessing.
  • Prefer a short, working example over a long prose explanation.
  • Keep headings shallow and scannable; use code fences for all commands.
  • Don't pad. Every section should earn its place.

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Gives 0 of the 12 instructions most readme changelog skills give in 243 tokens

Counted across 446 of the 460 authors here whose files we hold, read 2026-09-06

  • Follow Keep a Changelog formatin 24 of 446
  • Collect commits since the last git tagin 15 of 446, across 13 files
  • Omit empty sectionsin 14 of 446
  • Put breaking changes first with migration stepsin 14 of 446
  • Include migration guidance for breaking changesin 11 of 446, across 10 files
  • Categorize commits by conventional commit prefixin 11 of 446
  • Mark breaking changes prominentlyin 10 of 446
  • Prepend the new entry to CHANGELOG.mdin 9 of 446
  • Highlight breaking changes with migration notesin 8 of 446, across 7 files
  • Classify changes into Keep a Changelog categoriesin 8 of 446, across 7 files
  • Group related commits into single entriesin 8 of 446
  • Write the changelog from commitsin 8 of 446

Said here and by no other author read

  • Check it answers a new reader's questions in order
  • Restructure and tighten the prose
  • Flag uncertain commands or claims for the user
  • Keep headings shallow and scannable
  • Use code fences for all commands
  • Use the suggested section structure

Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.