SuperAPI AI 工具集

commit-conventions

通用与其它

查看项目

更新于 10-16 01:15

技能介绍

用途:该 Skill 用于约束 Skill System Foundry 仓库的提交信息格式与写法,在撰写提交信息、审查提交历史等场景下触发,使提交记录保持统一、可读。

主要能力与格式:每条提交信息以一行简短摘要开头,描述本次改了什么,并使用动词前缀:Update 用于对已有功能或文件的增强,例如 Update validation to check forward slashes;Add 用于全新的功能、文件或组件,例如 Add critique skill to .agents/;Fix 用于缺陷修复或纠正,例如 Fix false positive in name validation。

规则:一次提交只包含一项逻辑变更,不混入不相关改动;只保留摘要单行,除非改动异常复杂且从 diff 看不出原因,否则不写正文段落;优先写组件名而非文件名,如写 Update validation logic 而不是 Update validation.py,仅当组件名就是文件名时才写文件名,如 Update configuration.yaml;涉及多组件时用 and 连接,如 Update validation and constants;摘要末尾不加句号;不添加 Co-Authored-By 等任何尾注;不写 closes #N、fixes #N 等关闭 issue 的引用,issue 引用应放在 pull request 中。

版本号提交:使用固定格式 Update version to X.Y.Z。

边界情况:无行为变化的格式化或重构可用 Refactor 作为补充动词,如 Refactor validation into separate helper functions;仅测试改动可写 Add tests for forward-slash validation 或 Update tests for new edge cases;仅文档改动可写 Update README for new distribution channels;依赖更新可写 Update coverage to 7.6.1 in requirements-dev.txt。

限制:资料仅给出上述仓库内的提交规范与示例,未提供安装方式、运行命令、收费、价格、平台或效果等信息。