WePY项目Commit信息编写规范指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00205/article/details/148361803

WePY项目Commit信息编写规范指南

wepy 项目地址: https://gitcode.com/gh_mirrors/wep/wepy

前言

在WePY项目开发过程中，良好的Commit信息规范是团队协作的重要基础。本文将详细介绍如何为WePY项目编写规范的Commit信息，帮助开发者更好地记录代码变更历史。

Commit信息的基本结构

规范的Commit信息包含三个部分：

Header（必填）：简明扼要地描述变更类型和主要内容
Body（选填）：详细说明变更的具体内容和原因
Footer（选填）：包含破坏性变更说明或关联的issue信息

Header部分详解

Header部分是Commit信息的核心，必须遵循特定格式：

<type>: <subject>

变更类型(type)

WePY项目采用以下标准变更类型：

| 类型 | 说明 | |------------|-----------------------------| | feat | 新增功能 | | fix | 修复bug | | doc | 文档变更 | | style | 代码格式调整（不影响功能） | | refactor | 代码重构（非功能新增或bug修复） | | test | 测试相关变更 | | chore | 构建过程或工具链变更 |

主题描述(subject)

主题描述需要遵循以下规则：

使用动词开头，采用现在时态
首字母小写
结尾不加句号
简明扼要，不超过50个字符

正确示例：

feat: 增加小程序分享功能

错误示例：

Added sharing feature for mini program.  // 使用了过去时和句号

Body部分编写指南

Body部分用于详细说明变更内容，建议在以下情况下添加：

变更较为复杂，需要额外说明
修改涉及多个方面
需要解释变更原因

编写规范：

每行不超过72个字符
段落间用空行分隔
可以使用列表项
说明变更动机和与之前行为的对比

示例：

重构了组件生命周期处理逻辑

- 将原有分散的生命周期处理统一到core模块
- 优化了组件挂载性能
- 解决了父子组件生命周期顺序问题

Footer部分注意事项

Footer部分主要用于：

1. 破坏性变更(Breaking Changes)

当变更导致不兼容时，必须以BREAKING CHANGE:开头，说明：

变更内容
变更原因
迁移方案

示例：

BREAKING CHANGE: 移除了$broadcast方法

改用自定义事件系统进行组件间通信，迁移方案详见文档。

2. Issue关联

可以通过以下方式关联issue：

简单关联：

Issue #123

关闭issue（仅在合并到主分支时生效）：

Closes #123
Fixes #45
Resolves #67

完整示例

feat: 实现组件数据监听功能

新增了observers属性，用于监听数据变化：
- 支持路径监听
- 支持多字段监听
- 性能优化，避免不必要触发

BREAKING CHANGE: 移除了watch属性
原watch功能已整合到observers中，迁移时只需重命名属性。

Closes #112
Issue #113