ox01024/clear-naming

Dernière activité source enregistrée: 29 octobre 2026 à 08:08

Catalogue SkillsMP mis à jour: 12 novembre 2026 à 12:52

skills collectés: 1

Étoiles GitHub: 0
Forks GitHub: 0

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/ox01024/clear-naming.

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

# clear-naming · 清晰命名与表达让代码名称准确表达含义，让技术说明自然易懂。 An instruction-only agent skill for meaningful code names and clear technical explanations. Follow the reader's language, preserve technical precision, and judge names in context. ```diff - 等在飞任务排空后再退出。 + 等待正在执行的任务全部结束，然后退出。 ``` ## 它解决什么问题技术解释有时会把变量名逐词翻成中文，产生“在飞任务”等难以理解的表达。名称本身也可能只在作者熟悉的内部语境中才说得通。这个 skill 从两个地方改善理解： - **命名直接表意**：根据实现中的对象、动作和状态选择名称。 - **说明自然易懂**：直接讲行为、原因与结果，必要的术语首次出现时解释。同一个 `in_flight`，可能是正在执行的任务，也可能是等待响应的请求。它会先看上下文，再决定是否修改以及如何修改。HTTP、SQL、事务等有明确含义的术语可以继续使用。 ## 安装仓库根目录就是 skill 目录，包含标准的 `SKILL.md`。主体使用通用指令，`agents/openai.yaml` 提供 Codex 的显示名称与简介。使用支持本地 `SKILL.md` 的工具时，将整个目录放到该工具的技能目录。使用 [skills CLI](https://github.com/vercel-labs/skills)，按提示选择需要安装到的工具： ```bash npx skills add ox01024/clear-naming ``` 也可以手动安装。Codex：在终端执行以下命令，安装到个人技能目录： ```bash mkdir -p ~/.agents/skills git clone https://github.com/ox01024/clear-naming.git ~/.agents/skills/clear-naming ``` 团队也可以从项目根目录安装到当前仓库： ```bash mkdir -p .agents/skills git clone https://github.com/ox01024/clear-naming.git .agents/skills/clear-naming ``` 个人安装和项目安装按需要选择一种。团队需要把 skill 随项目提交时，复制技能目录中的文件或使用团队既有的依赖管理方式。 Codex 支持显式调用，也可以根据任务匹配技能说明。其他工具的安装位置与调用方式以其文档为准。参考 [Codex Skills 官方文档](https://developers.openai.com/codex/skills/)。 ## 使用 ### 把当前解释说清楚 ```text 使用 $clear-naming，解释刚才的“在飞任务”，用直接、自然的中文说明它在做什么。 ``` 只解决当前理解问题，不会因此发起全仓重命名。 ### 检查命名与说明 ```text 使用 $clear-naming 检查当前改动的命名、注释和说明。先给出建议，不修改文件。 ``` 检查结果会说明位置、实际含义、原表达、建议表达以及修改理由。已经清楚的名称保持原样；信息不足时指出需要核实的地方。 ### 修改指定范围 ```text 使用 $clear-naming 改善 scheduler.py 中难懂的命名和注释，保持行为一致，更新相关引用并运行必要检查。 ``` 公开接口、配置键、持久化字段与协议字段会检查兼容要求，区别于局部变量重命名。 ### 写入日常规则 ```text 使用 $clear-naming，把两条核心原则合并到当前项目根目录的 AGENTS.md。已有类似规则时原地合并。 ``` skill 按需加载。要让日常任务持续获得指导，可以把简短原则写入项目的指导文件；规则的效果仍需要实际使用反馈。修改全局指导文件时，请在请求中明确全局范围。参考 [Codex AGENTS.md 官方文档](https://developers.openai.com/codex/guides/agents-md/)。 ## 对照示例 | 实际上下文 | 可考虑的代码名称 | 自然说明 | | --- | --- | --- | | 已经开始且尚未结束的任务 | `running_tasks` | 正在执行的任务 | | 已发出、正在等待响应的请求 | `requests_awaiting_response` | 等待响应的请求 | | 同时包含等待与执行状态的未完成作业 | `unfinished_jobs` | 尚未完成的作业，包含等待启动和正在执行两种状态 | 这些名称是上下文示例。替代名称需要符合项目约定，并准确反映实现。更多场景见 [示例与边界](references/examples.md)，包括专业术语解释、失败原因、持久化字段兼容和重复合并规则。 ## 设计与验证第一版只包含指令、显示信息和例子，运行时无需脚本、额外依赖或外部服务。审阅或改进本 skill 时，检查它能否处理以下场景：仅改善解释；同词不同义；保留通行术语；信息不足时保留不确定性；修改公共字段时考虑兼容；重复写入规则时保持单份。验收依据是含义准确、读者能理解、引用完整以及行为一致。 ## 致谢与许可证工作方式参考 [pink-elephant](https://github.com/ox01024/pink-elephant) 的检查、修改与写入长期规则三种用法，聚焦命名和技术表达。 [MIT License](LICENSE)

Chargement du README du dépôt…

Publications

Tout voir →

Waffle

@jiaoao10247 nov. 2026 16:21 UTC

Annonce d’un SkillRelire du code et des PR

Résumé de la publication · anglais

Reviews code names and technical explanations in context, distinguishes tasks from requests, and proposes clearer wording without changing files during an audit.

Publication originale

Voir les détails du Skill · clear-naming/skill

Skills dans ce dépôt

classification en attente

skill

métier

description

mis à jour

clear-naming

non classé

Review and improve confusing code identifiers and technical explanations. Use for naming reviews, jargon cleanup, clearer explanations, or adding naming and communication guidance to AGENTS.md / CLAUDE.md. 中文触发：命名审查、消除黑话、解释通俗一点、不要直译变量名、添加清晰表达规则。 Ordinary…

Langue du texte source : chinois

2026-10-29

Affichage de 1 skills collectés sur 1.