Engram 提交卫生规范
为 Engram 贡献者强制实施 Conventional Commits 与分支命名标准,确保提交历史清晰可审计。
该技能仅规定提交与分支命名规范,由 GitHub 规则集强制,无敏感数据处理与外部副作用。但未提供配置、验权或审核步骤,也未说明如何回滚,信任场景不完整。
规则详细且自洽,但未提供测试或错误处理说明,静态审查下无法验证执行效果。
适用场景明确(创建提交、分支、评审),但未声明能力边界与非适用场景,触发描述依赖隐含理解。
文档结构清晰,含版本、作者、示例与无效示例,但未提及已知限制、变更日志、维护责任与更新路径。
技能能提供规范,但缺乏验证其效果的直接证据,静态审查下无法确认其价值是否显著超越手动操作。
关键声明(如 GitHub 规则集强制执行)在仓库中未见对应配置,也无测试或第三方执行证据,无法独立验证。
- 技能依赖 GitHub 规则集强制,但仓库中未见对应 ruleset 配置,用户需自行确认实际生效。
- 技能只覆盖提交与分支命名,可能不适用于其他版本控制平台(如 GitLab、Bitbucket)。
- 对中文用户无特殊适配,但材料本身为英文,适用范围不受网络可达性影响。
这个 Skill 能做什么,适合哪些场景?
该技能为 Engram 仓库定义了严格的提交与分支命名规范,涵盖 11 种提交类型、可选作用域、破坏性变更标记及强制性的 type/description 分支格式。这些规则由 GitHub 规则集强制执行,违规的 push 会被直接拒绝。技能提供 GitHub 规则集使用的正则表达式、有效与无效示例以及提交前检查清单,帮助贡献者一次提交通过。适用于提交、分支创建、PR 审查和清理暂存更改。
定义并解释 Conventional Commits 格式(<type>(<scope>): <description> 及 ! 破坏性变更标记),列举 11 种允许的提交类型;定义分支命名正则 ^(feat|fix|chore|docs|style|refactor|perf|test|build|ci|revert)\/[a-z0-9._-]+$;给出有效与无效的提交与分支示例;提供提交前检查清单(确认格式、无多余文件、无敏感信息、无 Co-Authored-By)。不执行任何自动化检查——仅提供指导。
- 贡献者在创建提交时,需确保消息符合 Conventional Commits 格式,避免被 GitHub 规则集拒绝。
- 开发者新建分支时,需按照 `type/description` 格式命名,确保分支名符合仓库标准。
- 维护者在审查 PR 时,根据此规范检查提交历史和分支命名是否合规。
- 贡献者在清理暂存更改时,参照检查清单确保没有提交生成文件或本地配置。
这个 Skill 有哪些优点和局限?
- 提供明确的提交与分支格式,减少沟通成本。
- 由 GitHub 规则集强制执行,确保一致性。
- 包含详细的示例和检查清单,易于遵循。
- 适用于任何支持 Conventional Commits 的项目。
- 仅适用于该特定仓库(Engram),通用性有限。
- 技能本身不提供自动化,仅依赖外部规则集。
- 未提及对 Windows 或旧版 Git 的兼容性问题。
- 无自动化测试或验证手段,依赖人工遵守。
如何安装这个 Skill?
此技能作为 Gentleman-Programming/engram 仓库的一部分,位于 skills/commit-hygiene/SKILL.md。克隆仓库或将技能文件夹复制到您的 Agent Skills 目录。安装后,Agent 将在相关场景(提交、分支、审查)中自动加载此技能。
如何使用这个 Skill?
当创建提交、命名分支或审查 PR 时,Agent 会依据此技能提供格式指导。例如,用户可提示“根据此仓库的提交规范生成提交消息”,Agent 将按照技能中的类型、作用域和描述规则生成符合要求的消息。