SuperAPI AI 工具集

engram-commit-hygiene

通用与其它

查看项目

更新于 10-15 21:50

技能介绍

用途:为 Engram 贡献者统一提交信息与分支命名标准,由 GitHub rulesets 强制执行,不合规推送会被拒绝。

主要能力与规则:提交信息必须遵循 Conventional Commits,格式为 <type>(<可选 scope>): <描述>,破坏性变更用 <type>(<可选 scope>)!: <描述>。可用类型:feat、fix、docs、refactor、chore、style、perf、test、build、ci、revert。类型须小写且为所列值;scope 可选、小写,允许 a-z、0-9、.、、-;描述须为祈使语气,冒号加空格后开始。分支名格式为 <type>/<description>,description 须小写,仅允许 a-z、0-9、.、、-,不允许大写、空格或特殊字符。每次提交只包含一个逻辑变更,信息应说明原因而非仅描述内容,禁止包含 Co-Authored-By 尾注,禁止提交 Transient Artifact Policy 禁止的路径。

使用方式:在创建提交、创建或命名分支、审查 PR 提交历史、清理暂存改动时应用;提交前按清单自查提交信息格式、分支名格式、差异是否与提交范围一致、是否含密钥或 .env 文件、每个变更路径是否符合政策、是否含 Co-Authored-By 尾注,并确保相关测试通过。

限制:规则由 GitHub rulesets 在推送时校验,不合规会被拒绝;资料未提供安装命令、收费与价格、平台支持范围等信息。