PR_GUIDELINES_ZH.md

Pull Request 提交规范指南

概述

本文档规定了向 Vue 3 零代码平台项目提交 Pull Request (PR) 时应遵循的规范。遵循这些规范可以帮助维护者更好地理解您的更改并更高效地审查您的 PR。

PR 标题格式

格式：type(scope): description

类型（type）：

• feat: 新功能
• fix: 修复 bug
• docs: 文档修改
• style: 不影响代码含义的更改（空格、格式化等）
• refactor: 代码重构（既不是修复 bug 也不是添加新功能）
• perf: 性能优化
• test: 添加或修改测试
• chore: 构建过程或辅助工具的变动

作用域（scope）：

指定影响的模块/组件，例如：

• editor：编辑器相关
• renderer：渲染器相关
• components：组件相关
• utils：工具函数相关
• docs：文档相关

描述（description）：

• 使用清晰简洁的语言
• 使用动词开头
• 控制在 50 个字符以内
• 结尾不加句号

标题示例：

feat(editor): 添加拖拽组件面板功能
fix(renderer): 修复组件渲染问题
docs(readme): 更新安装说明文档

PR 描述模板

PR 类型（勾选所有适用项）

• ✨ 新功能
• 🐛 Bug 修复
• 📝 文档更新
• 🎨 代码格式
• 🔨 代码重构
• 📈 性能优化
• ✅ 测试相关
• 🤖 构建相关

描述

{详细描述你的更改。包括这些更改的动机和任何审阅者应该了解的上下文。}

相关 Issue

修复 #{issue编号}

截图/视频（如果适用）

{添加截图或视频来解释你的更改}

检查清单

• 我已阅读贡献指南
• 我的代码符合项目的代码风格
• 我已经为代码添加了必要的注释，特别是在难以理解的区域
• 我已经更新了相关文档
• 我的更改没有产生新的警告
• 我添加了证明我的修复是有效的或功能正常工作的测试
• 所有新的和现有的测试都通过了

补充说明

{任何你想分享的额外信息}

PR 描述示例

✨ 新功能：添加组件库面板

### PR 类型

- [x] ✨ 新功能
- [ ] 🐛 Bug 修复
- [ ] 📝 文档更新
- [ ] 🎨 代码格式
- [ ] 🔨 代码重构
- [ ] 📈 性能优化
- [ ] ✅ 测试相关
- [ ] 🤖 构建相关

### 描述

本 PR 为编辑器界面添加了新的组件库面板。该面板提供了可搜索的组件列表，用户可以通过拖拽方式将组件添加到项目中。主要功能包括：

- 分类展示组件列表
- 搜索功能
- 悬停预览组件
- 拖拽交互界面
- 组件元数据展示

### 相关 Issue

修复 #123

### 截图

![组件面板截图](./docs/assets/component-panel.png)

### 检查清单

- [x] 我已阅读贡献指南
- [x] 代码符合项目风格
- [x] 已添加代码注释
- [x] 已更新相关文档
- [x] 没有新的警告
- [x] 已添加测试
- [x] 所有测试通过

### 补充说明

搜索功能目前仅支持中文和英文。国际化支持将在后续 PR 中添加。

最佳实践

1. 保持专注

   • 每个 PR 只处理一个主题
   • 将大的改动拆分成多个小的 PR

2. 自我审查

   • 提交前自行检查 PR
   • 检查拼写错误、调试代码和控制台日志
   • 确保所有测试通过

3. 文档同步

   • 更新相关文档
   • 为复杂逻辑添加注释
   • UI 更改需要添加截图/视频

4. 测试要求

   • 为新功能添加/更新测试
   • 验证现有测试是否通过
   • 测试边界情况

5. 积极响应

   • 及时响应审查者的评论
   • 虚心接受反馈和建议
   • 根据审查及时更新 PR

审查流程

1. 提交 PR

   • 完整填写 PR 模板
   • 添加合适的标签
   • 请求相关团队成员审查

2. 处理审查意见

   • 回复所有评论
   • 进行请求的更改
   • 必要时更新 PR 描述

3. 合并要求

   • 所有必要的审查都已批准
   • CI 检查通过
   • 没有合并冲突
   • 与主分支保持同步

合并后工作

1. 合并后删除你的分支
2. 关闭相关 Issue
3. 监控部署情况（如适用）
4. 在预发环境验证你的更改

---

遵循这些规范有助于维护项目质量，使代码审查过程更加顺畅。感谢您为我们的项目做出贡献！