Individual skill
good-readme
Use when the user asks to create, rewrite, review, or polish an open-source README, including shop-window READMEs. Not for remote, credential, publish, deploy, or irreversible changes.
.devin/skills/good-readme/SKILL.md
Source commit b0e8ce89a19fac880251dc3ea1babfeb4503a4fe
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Not checked yet
- Last checked
- Nov 4, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 55
- Repository last updated
- Sep 28, 2026
- License
- Apache-2.0
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- odd Repository topic
- odin Repository topic
- outline Repository topic
- outlines Repository topic
- coding-paradigm Repository topic
- outline-driven-development Repository topic
- claude-plugins Repository topic
- codex-cli Repository topic
- gemini-cli-extensions Repository topic
- outline-driven Repository topic
- docs Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
SKILL.mdcore · 10,006 bytesSKILL.mdcore · 10,006 bytesSKILL.mdcore · 10,006 bytesSKILL.mdcore · 10,006 bytesSKILL.mdcore · 10,006 bytesSKILL.mdcore · 10,006 bytesSKILL.mdcore · 10,006 bytesagents/openai.yamlasset · 179 bytesreferences/badges.mddoc · 1,545 bytesreferences/quality-checklist.mddoc · 1,451 bytesreferences/section-templates.mddoc · 1,067 bytes
Read excerpt
# Good README
## Contract
| Field | Bound contract |
|---|---|
| Trigger | User asks to create, rewrite, review, or polish an open-source README. |
| Authority | Reversible local: writes only README.md; rollback is version control or the editor undo history. No remote mutation. |
| Side effect | Edits README.md into a progressively disclosed, evidence-grounded project introduction, example, and getting-started guide. |
| Done | Claims are sourced, the opening explains benefit and difference, the 4–10-line example is self-explanatory, clean-machine setup works, and headings alone tell the story. |
## Inputs
- The project repository containing or awaiting a README.md. A README may not yet exist; create it.