wayne-skills
CLAUDE.md9 starsChanged 9 months agoMITView on GitHub
在创建 pywayne 库的 skill 时,必须按照源码和文档的目录结构对 skill 进行命名(name)和目录结构。 目录结构: - 所有 pywayne skill 都应放在 pywayne/ 目录下 - 子目录名使用连字符(-),Python 模块的下划线 _ 转连字符 - - SKILL.md 的 name 字段使用完整路径(连字符分隔,符合 hyphen-case 规范) 命名原则: 1. 源码使用下划线:Python 模块名遵循 PEP8 规范使用下划线(如 chat_bot.py) 2. Skill 目录使用连字符:下划线 _ 转连字符 -(如 chat-bot/) 3. Skill name 使用连字符:将路径 / 替换为 -,全部使用小写(如 pywayne-llm-chat-bot) 4. 符合 hyphen-case 规范:只允许小写字母、数字和连字符(打包脚本验证要求) 目的: - 使 skill 目录结构与 pywayne 库的代码组织保持一致 - 便于用户理解 skill 对应的源码位置 - 简化技能管理和查找 创建 skill 并打包后,必须执行以下清理: 原因: - .skill 文件只用于分发,源码仓库不需要 - 避免空目录占用仓库空间 在为本仓库编写或重写 README.md 时,遵循以下规则,确保文档可维护、可检索、可扩展:
In this repository15 other files it gives its agents.
- AGENTS.mdAGENTS.md
- alapiSkill
- android-app-publisherSkill
- awesome-docsSkill
- calib-pattern-generatorSkill
- deep-thinkSkill
- learning-tutorSkill
- proactive-agentSkill
- research-paper-deep-diveSkill
- send-emailSkill
- shell-shortcutsSkill
- technical-explainer-videoSkill
- tutor-generalSkill
- tutor-math-geometrySkill
- week-report-systemSkill
The file
Files
Pywayne Skill 命名规范
Skill 命名规则
在创建 pywayne 库的 skill 时,必须按照源码和文档的目录结构对 skill 进行命名(name)和目录结构。
目录结构:
- 所有 pywayne skill 都应放在
pywayne/目录下 - 子目录名使用连字符(
-),Python 模块的下划线_转连字符- - SKILL.md 的
name字段使用完整路径(连字符分隔,符合 hyphen-case 规范)
示例:
| 源码目录 | Skill 目录结构 | SKILL.md name |
pywayne/lark_custom_bot.py | pywayne/lark-custom-bot/ | pywayne-lark-custom-bot |
pywayne/bin/cmdlogger | pywayne/bin/cmdlogger/ | pywayne-bin-cmdlogger |
pywayne/tts | pywayne/tts/ | pywayne-tts |
pywayne/bin/gettool | pywayne/bin/gettool/ | pywayne-bin-gettool |
pywayne/bin/gitstats | pywayne/bin/gitstats/ | pywayne-bin-gitstats |
pywayne/calibration/magnetometer_calibration.py | pywayne/calibration/magnetometer-calibration/ | pywayne-calibration-magnetometer-calibration |
pywayne/vio/tools.py | pywayne/vio/tools/ | pywayne-vio-tools |
pywayne/vio/SE3.py | pywayne/vio/se3/ | pywayne-vio-se3 |
pywayne/vio/SO3.py | pywayne/vio/so3/ | pywayne-vio-so3 |
pywayne/llm/chat_bot.py | pywayne/llm/chat-bot/ | pywayne-llm-chat-bot |
命名原则:
- 源码使用下划线:Python 模块名遵循 PEP8 规范使用下划线(如
chat_bot.py) - Skill 目录使用连字符:下划线
_转连字符-(如chat-bot/) - Skill name 使用连字符:将路径
/替换为-,全部使用小写(如pywayne-llm-chat-bot) - 符合 hyphen-case 规范:只允许小写字母、数字和连字符(打包脚本验证要求)
目的:
- 使 skill 目录结构与 pywayne 库的代码组织保持一致
- 便于用户理解 skill 对应的源码位置
- 简化技能管理和查找
Skill 创建后清理
创建 skill 并打包后,必须执行以下清理:
- 删除
.skill文件 - 打包文件不需要保留在源码仓库中 - 删除
scripts/references/assets中的空文件夹 - 保留非空的文件夹
原因:
.skill文件只用于分发,源码仓库不需要- 避免空目录占用仓库空间
示例:
# 创建后(需要清理)
./
├── pywayne/
│ └── plot/
│ ├── SKILL.md
│ ├── scripts/ # 空,删除
│ ├── references/ # 空,删除
│ └── assets/ # 空,删除
└── plot.skill # 打包文件,删除
# 清理后
./
└── pywayne/
└── plot/
└── SKILL.mdREADME 编写规范(经验总结)
在为本仓库编写或重写 README.md 时,遵循以下规则,确保文档可维护、可检索、可扩展:
- 先定义定位:开头必须说明仓库目标、适用对象、与
pywayne源仓库的关系(本仓库维护 skill,不维护源码实现)。 - 明确映射关系:写清楚“源码模块路径 -> skill 目录路径 -> skill name”的映射原则,并给出真实示例。
- 结构优先:README 至少包含以下板块:
- 项目目标
- 仓库结构
- 命名与目录规范
- 技能清单(按领域分组)
- 维护建议
- 技能清单必须基于仓库真实文件生成,不靠人工记忆;以
**/SKILL.md为准,避免遗漏和过期信息。 - 分组展示而非平铺:pywayne 技能按领域归类(如 CV、LLM、VIO、工具链等),每项至少包含:
Skill Name路径作用(一句话)
- 与规范保持一致:README 内容必须与当前
CLAUDE.md的命名规则一致;若规则更新,README 需同步更新。 - 控制信息密度:描述尽量一行一句,减少冗余背景;优先“怎么用/在哪里/做什么”。
- 可维护性优先:统计数字(如技能总数)应在更新时复核,避免“写死后失真”。
- 默认语言为英文:仓库主 README 使用英文(
README.md),中文放在README_ch.md,并在顶部双向跳转。 - 双语一致性:中英文 README 结构应基本一致,关键信息(数量、路径、规则)必须同步。
- 视觉吸引力:允许使用适量 emoji 强化可读性(标题、分组、亮点),但避免堆砌和干扰信息检索。
- 酷炫但务实:优先使用“短标语 + 亮点列表 + 快速概览表 + 检查清单”的结构,不牺牲准确性。
README 风格建议(中英文通用)
- 开头使用一句 slogan(可配 emoji)快速建立定位。
- 设置
At A Glance / 快速概览表格,优先展示总数、分类、入口文档。 - 关键板块标题可使用语义 emoji(如
✨、📌、🗂️、🔗、✅)。 - 每段尽量短句,强调可扫描性;列表优先,减少长段叙述。
- “吸引人”不等于“花哨”:数据、路径、命名规则仍是第一优先级。
README 更新流程(建议执行)
- 读取
CLAUDE.md与当前README.md,确认最新规范。 - 扫描仓库
SKILL.md列表并提取name、description。 - 先搭好 README 骨架,再填充技能分组表。
- 自检三项:
- 路径是否存在
- 技能数量是否匹配
- 命名是否符合 hyphen-case 规则
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.

