✨ docs: 把提交信息规范固化成 CONTRIBUTING.md
约定 emoji 在行首、类型关键字与作用域用英文、描述用中文,并给出 10 种 类型的 emoji 与码位表。因为行首 emoji 会让 commitlint / semantic-release 这类工具读不到类型,规范里同时记录了两种应对方式。 顺手修掉 README 里一句会误导的话:本地 link: 安装时,profile 的 node_modules 可能是与源码同 inode 的硬链接副本,只刷新页面看不到改动。
This commit is contained in:
+10
@@ -0,0 +1,10 @@
|
||||
# <emoji> <type>[(scope)][!]: <中文描述,不超过 72 宽度,不加句号>
|
||||
# 类型与 emoji:feat ✨ / fix 🐛 / docs 📝 / refactor ♻️ / perf ⚡️ /
|
||||
# test ✅ / build 📦️ / ci 💚 / chore 🔧 / revert ⏪️
|
||||
# 例:✨ feat(client): 会话行悬停区加删除按钮
|
||||
# 例:🐛 fix(host): 延迟删除台账只记录根会话
|
||||
#
|
||||
# ↓ 正文(可省略):为什么这么改、影响面、迁移注意事项,每行不超过 72 宽度
|
||||
#
|
||||
#
|
||||
# ↓ 脚注(可省略):Refs: #12 / Closes: #34 / BREAKING CHANGE: <中文说明>
|
||||
Reference in New Issue
Block a user