用途
README 更新技能用于智能更新 README.md,使其与代码变更保持同步。它面向需要维护项目文档、但又不想手工逐项比对的开发者,通过自动检测变更并给出 README 更新建议来减少遗漏。
触发条件
- 用户说「更新 README」或「update readme」。
- 被 git-precommit 编排器调用。
- 新增重要功能之后。
该技能的法规依据为宪法文件 CONSTITUTION.md 第 6 条。
更新策略
技能会先检测变更类型,再决定更新哪些区块。
变更类型与对应动作:
- 新功能:更新功能列表。
- 新依赖:更新安装说明。
- API 变更:更新使用范例。
- 结构变更:更新项目结构。
按区块划分的更新条件:
- 功能列表:新增或移除功能时更新。
- 安装说明:依赖变更时更新。
- 使用范例:API 变更时更新。
- 项目结构:目录结构变更时更新。
- 配置说明:新增设定选项时更新。
以下区块不自动修改,需要保持原样:
- 授权信息。
- 贡献指南。
- 致谢。
使用方式
技能在触发后输出固定格式的分析结果,包括:
- 变更检测:列出检测到的变更,例如新增功能、新增依赖。
- 建议更新:说明应更新哪些区块及具体内容。
- 预览:以 diff 风格展示 README 中即将发生的改动,例如在功能列表中添加一行新增功能。
适用场景
- 代码提交前由预提交编排器统一调用,提前提醒文档同步。
- 新增重要功能后,需要同步更新 README 的功能列表。
- 依赖、API、目录结构或配置项发生变化时,需要对应更新文档中的说明段落。
限制
- 不会自动修改授权信息、贡献指南、致谢等区块。
- 是否实际写入 README、写入范围与执行细节暂未提供。
- 支持的平台、版本要求、安装命令暂未提供。