read-readmes
Skill0 starsChanged 24 days agoMITView on GitHub
Read project README files for context when working in a repository, and change them only when the user explicitly requests README changes.
In this repository9 other files it gives its agents.
- agent-browserSkill
- broSkill
- cache-network-transfersSkill
- code-commentsSkill
- correctSkill
- dry-listsSkill
- nix-for-toolsSkill
- sharpenSkill
- unslopSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
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 6
Read the project's root README before starting work.
- Distinctive: line 8
Use these files to understand the project's purpose, setup, conventions, and relevant workflows.
- Distinctive: line 12
If your work makes a README inaccurate, leave it unchanged and briefly mention the discrepancy in your final response.
- Distinctive: line 14
When README changes are explicitly requested, keep them within the requested scope.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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.
Files
Read the project's root README before starting work. Read README files in relevant subdirectories before working in those areas. Treat README filenames case-insensitively and include formats such as README, README.md, and README.rst.
Use these files to understand the project's purpose, setup, conventions, and relevant workflows.
Do not create, edit, rename, or delete README files unless the user explicitly asks for README changes. A request to implement a feature, fix a bug, refactor code, or update documentation generally does not by itself authorize README changes. An explicit request already made in the conversation is sufficient; do not ask for confirmation again.
If your work makes a README inaccurate, leave it unchanged and briefly mention the discrepancy in your final response. Continue the authorized work without stopping to seek permission for a README update.
When README changes are explicitly requested, keep them within the requested scope.
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
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.