代码规范

一、代码提交规范

Commit Message 提交结构规范：

<Type>(<scope>可选): <subject>
// 空一行
<Body>
// 空一行
<Footer>

🍄 Header: 纯英文填写，必填

type: 代表 commit 的类别：feat, fix, docs, style, refactor, test, chore，必要栏位；
scope 代表 commit 影响的范围，例如资料库、控制层、模板层等等，视专案不同而不同，为可选栏位。scope 以功能模块名称，全小写为主；
subject 代表此 commit 的简短描述，全小写为主，不要超过 50 个字元，结尾不要加句号，为必要栏位。

🍄 Body: 选填

Body 部份是对本次 Commit 的详细描述，可以分成多行，每一行不要超过 72 个字符；
说明程式码变动的项目与原因，还有与先前行为的对比。

🍄 Footer: 选填

填写任务编号（如果有的话）；
BREAKING CHANGE（可忽略）：记录不兼容的变动，以 BREAKING CHANGE: 开头，后面是对变动的描述、以及变动原因和迁移方法。

Commit Type 类别规范:

type

释义

header示例（详细示例参考下方范例）

feat

新增/修改功能 (feature)

feat:add login function

fix

修补 bug

fix: fix logout error

docs

文档变更

docs: add readme.md

style

纯样式的变动, 不影响代码运行逻辑

style: change white-space and font-size

refactor

重构（既不是新增功能，也不是修补 bug 的代码变动）

refactor: simplify code structure and improve readability

perf

改善性能的代码变动

perf: optimize database query performance for user search

test

添加缺失的测试

test: add unit tests for XYZ feature

chore

建构程序或辅助工具的变动（维护日常琐事）

chore: update vite version chore: fix a bug in XYZ feature

revert

撤销先前的 commit

revert: fix issue with login page rendering

📇范例：

## Header 
fix: 自订表单新增/编辑页面，修正离开页面提醒逻辑

## Body
❓问题：
1. 原程式码进入新增页面后，没做任何动作之下，离开页面会跳提醒
2. 原程式码从新增/编辑页面回到上一页后（表单列表页面），离开页面会跳提醒
💭原因：
1.新增页面时，页面自动建立空白题组会调用 sort_item，造成初始化 unload 事件处理器。
🦾调整：
1. 初始化 unload 事件处理器：排除新增表单时，页面自动建立空白题组调用 sort_item 的情境
2. 回到上一页后，复原表单被异动状态且清除 unload 事件处理器 

## Footer
issue #1335

此外：请注意

Notice: 合并到主干分支的 Merge 信息请择一填写。完成使用 resolved, 还未完成用 related，后方以 # 带 issue 编号 :


related #123

or

resolved #123

二、前端组件命名规范

Previous主干开发

Last updated 2 years ago