pyh
|
229ff342d9
|
📝 docs: 规定提交信息只有标题不要正文与脚注
|
2026-09-30 16:58:42 +08:00 |
|
pyh
|
07f5af6fff
|
📝 docs: 讲清"单行"指首行,正文不禁止
之前的措辞容易被读成"提交信息只能有一行"。现在把三段结构摆出来,并写明
首行、正文、脚注各自的要求与宽度上限,正文和脚注都标注为可省略。
顺带说明:正文不是违规内容,没有正文是允许而不是必须。
|
2026-09-30 16:56:04 +08:00 |
|
pyh
|
83eae74f63
|
📝 docs: 补上提交信息规范的自查脚本
scripts/check-commit-log.mjs 按 CONTRIBUTING.md 的类型表检查提交首行,
只报告不拦提交。它从规范文件里读 emoji 对照,所以改表不用改脚本。
同时收紧规范:emoji 由「可选」改为「必需且必须与类型一致」。原先的写法
下 ✨ docs: 这类不匹配不会被发现。
|
2026-09-30 16:50:29 +08:00 |
|
pyh
|
b5545b0806
|
✨ docs: 把提交信息规范固化成 CONTRIBUTING.md
约定 emoji 在行首、类型关键字与作用域用英文、描述用中文,并给出 10 种
类型的 emoji 与码位表。因为行首 emoji 会让 commitlint / semantic-release
这类工具读不到类型,规范里同时记录了两种应对方式。
顺手修掉 README 里一句会误导的话:本地 link: 安装时,profile 的
node_modules 可能是与源码同 inode 的硬链接副本,只刷新页面看不到改动。
|
2026-09-30 16:49:22 +08:00 |
|