Home

Branches

Branch	Description
main	Developments of few custom features (GitHub Actions on push)
docs	Improvements or additions to documentation

Deploy

To keep two functionally independent branches.

• docs => main: --merge merge branch docs to main
• main => docs: --rebase rebase branch docs to main

Commit message

Format

{emoji} {type}: {subject within 50 words} (#{issue/pull request})

Emoji

• https://gitmoji.dev
• vscode plugin
• utools plugin GitEmoji

Message

• Emoji optional
• Type required

Emoji	Type	类型	例子	说明（内容需具体、不可模稜两可）
✨ 🎉	Feat	新增	Feat: 新增 {功能名称}	新增功能
🚚		调整	Feat: 调整 {功能名称}，{变动内容}	调整功能，需叙述现况(before)、调整后(after)
🔥		删除	Feat: 删除 {功能名称}，{删除原因}	删除功能，须说明删除原因
🐛 🚧 🚨	Fix	修正	Fix: 修正 {Bug 说明}	修正已知的 BUG
🎨 💄 ✏️	Style	排版	Style: 排版 {优化内容}	不影响代码运行的变动，如：代码排版
♻️	Refactor	重写	Refactor: 重写 {功能名称}	既不是新增功能，也不是修补 bug 的代码变动，单纯重写某个功能的代码，并不影响功能结果
⚡	Perf	改善性能	Perf: 改善性能 {功能名称}，{改善内容}	优化代码的性能
⏪	Revert	恢復版本	Revert: 恢復版本 {恢復的版本 commit message}	恢復某一个 commit 的版本
📝 ✏️	Docs	文档/注释	Docs: 修正注释	文档、注释的调整
🔧	Chore	内部构建	Chore: update plugin version	构建过程或辅助工具的变动