菜单
Review or write README content for open-source projects. Enforces progressive disclosure, jargon-free language, and single-concept code examples. Use when asked to "write README", "review README", "update README", or "check docs".
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/CelestoAI/SmolVM --skill readme-guidelines命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
基于 SOC 职业分类
正在显示 SKILL.md
| name | readme-guidelines |
| description | Review or write README content for open-source projects. Enforces progressive disclosure, jargon-free language, and single-concept code examples. Use when asked to "write README", "review README", "update README", or "check docs". |
| argument-hint | <file-or-section> |
| metadata | {"author":"Celesto Team","version":"1.0.0"} |
Review or write README content following these principles. The goal is easy onboarding for both newcomers and advanced users.
Structure content so readers can stop at any point and still have a working mental model. Each section should be usable on its own:
Each code block should demonstrate exactly one idea. If a snippet requires the reader to understand two or more new things simultaneously, split it.
Wrong — introduces sandbox creation AND environment variables at the same time:
with SmolVM(env={"API_KEY": "secret"}) as vm:
vm.run()
Right — teaches sandbox creation first, env vars in a separate example:
with SmolVM() as vm:
vm.run("echo 'hello'")
Explain every concept as if talking to a first-year CS student before using technical terms. Then go deeper if the reader needs it.
Never use a value, flag, or identifier in a code block without explaining where it comes from. If a command prints a session_id, show that command before any command that takes session_id as input.
When reviewing a README, check each section against these rules:
<session_id>, <vm_id>): is it introduced before it's used?For each violation found, output:
Line <N>: [rule violated]
Current: <quote the problematic text>
Fix: <suggested rewrite>
Then provide a revised version of any section that has more than one violation.