update-readme
Skill1 starsChanged 7 months agoMITView on GitHub
Update README.md after a structural change to the project. Trigger this skill when a new class is added, a new public method is introduced, or the roadmap changes. Also trigger automatically at the end of every working session, alongside update-backlog. Also trigger when the user says "update the README", "document this", or "add this to the README". Do not trigger for internal refactoring, bug fixes, or test-only changes.
8 other projects use a version of this.
Adopted by
Most recently taken up by
- himkt/cafleettheir own version, first seen Nov 8, 2026
- FradSer/skillstheir own version, first seen Oct 13, 2026
- vekzz-dev/opencode-skillstheir own version, first seen Oct 3, 2026
- emaraschio/cursor-commandstheir own version, first seen Aug 7, 2026
- iden0605/Claude-Skillstheir own version, first seen Jul 1, 2026
- oiiiwjh/skillstheir own version, first seen Mar 16, 2026
Other versions8 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 8
- himkt/cafleet★ 56same name
- emaraschio/cursor-commands★ 9same name
- FradSer/skills★ 4same name
- oiiiwjh/skills★ 4same name
- vekzz-dev/opencode-skills★ 4same name
- paulo-yamagishi/claude-code-setup★ 2same name
- andyshen1121/skills★ 1same name
- iden0605/Claude-Skills★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository12 other files it gives its agents.
- api-consistency-checkSkill
- architecture-drift-checkSkill
- design-reviewSkill
- jml-completeness-checkSkill
- jml-conformance-checkSkill
- jml-designSkill
- jml-test-generationSkill
- new-classSkill
- refactor-classSkill
- static-analysisSkill
- test-coverage-reviewSkill
- update-backlogSkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 7 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 5 edited versions we read keep these.
7
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 25
Do not update the README for:
- Distinctive: line 34
Read the current README.md in full to understand the existing structure and tone before making any modifications.
- Distinctive: line 43
Add a new section under the appropriate heading.
- Distinctive: line 63
Add to Features if the method is significant and not already implied
- Distinctive: line 64
Update Usage if a new example would be helpful
- Distinctive: line 65
Do not rewrite the whole section — surgical edits only
- Distinctive: line 81
All text in English
“Common” is measured: kept by at least 6 in 10 of the 5 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.
Files
Update README
When to run
- A new class or module was added to the project
- A new public method was added to an existing class (if significant enough to appear in the README)
- The roadmap changed (item completed, new item added, item rephrased)
- At the end of every working session — run alongside
update-backlog, even if no explicit change was requested (skip only if the session contained no public API change and no roadmap change)
Do not update the README for:
- Internal refactoring with no public API change
- Bug fixes that don't affect documented behaviour
- Test-only changes
Before writing anything
Read the current README.md in full to understand the existing structure and
tone before making any modifications. Preserve the existing tone.
Procedure by trigger
Trigger: new class or module added
Add a new section under the appropriate heading. Include:
- How it works — explain the core data structure and its invariant in plain English. Include an ASCII diagram if the structure is spatial. One short paragraph on the performance trade-offs vs. standard library alternatives.
- Architecture — a markdown table with columns
TypeandRolelisting interfaces, implementations, and synchronized variants. - Features — a bullet list of the main public capabilities.
- Usage — code examples that compile against the actual public API. Cover: basic construction, the most common operation, any class-specific feature. Examples must be self-contained.
- Thread safety (only if a synchronized variant exists) — summarise which implementation is thread-safe, the locking strategy, and iterator behaviour (fail-fast vs. snapshot).
Trigger: new public method on an existing class
Locate the existing section. Update only what has changed:
- Add to Features if the method is significant and not already implied
- Update Usage if a new example would be helpful
- Do not rewrite the whole section — surgical edits only
Trigger: roadmap changed
Locate the roadmap section. Apply one of:
- Item completed → remove it from the roadmap (it is now documented under the main sections)
- New item added → append a bullet with the same style as existing entries
- Item rephrased → edit in place
Style rules
- All text in English
- Backticks for all type names, method names, and code references inline
- Fenced code blocks for all code examples
- Tables use the compact
|---|---|separator style - No trailing whitespace
- Preserve all existing section order and heading levels exactly
Before presenting the result
Show the user a summary of what was changed:
- Which sections were added
- Which sections were modified
- Which sections were left untouched
Then present the updated content for review. Do not instruct the user to merge blindly — flag anything uncertain for their decision.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.

