diff --git a/README.md b/README.md index ad5cb66..d7d8726 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,6 @@ * **用途**: * 用于修复一般性 Bug; - * 可从 `dev` 或 `main` 创建,视问题是否影响生产环境而定。 * **命名规范**: @@ -74,9 +73,9 @@ * **开发流程**: - 1. 从 `dev` 或 `main` 分支拉取最新代码; + 1. 从 `dev` 分支拉取最新代码; 2. 完成修复后提交并推送到远程仓库; - 3. 创建拉取请求(PR),合并回相应分支(通常为 `dev`,若需立即上线可合并至 `main`)。 + 3. 创建拉取请求(PR),合并回相应分支。 #### 发布分支 (`release/*`) @@ -114,7 +113,6 @@ 3. 创建拉取请求(PR),将 `hotfix` 分支合并至 `main` 并打上版本标签; 4. 同时将修复内容合并回 `dev`,避免后续开发再次出现同样问题; 5. **回滚策略**:若修复未能解决问题,立即回滚合并,删除 `hotfix` 分支并通知团队,确保不影响生产环境。 ---- ### 2.7 分支流程图 @@ -180,7 +178,7 @@ flowchart LR 提交信息应简洁且具有描述性,格式如下: ``` -[类型] 描述 +[提交类型] 描述 详细描述(可选) ``` @@ -206,7 +204,10 @@ flowchart LR ### 3.2 提交实践 -* 提交时,请确保代码是否符合项目的编码规范。 +* 提交信息可使用 `jetbrains 插件` [Lingma - 阿里云 AI 编程助手](https://plugins.jetbrains.com/plugin/17809-lingma--alibaba-cloud-ai-coding-assistant) 快速生成初版。 + >不能生成后直接提交因为生成的 `提交类型` 会生成不符合本规范的版本,但是 `详细描述` 可以使用。 + +* 提交时,请确保代码是否符合项目的[编码规范](https://gitea.fireflydt.com/docs/Encoding-Specification)。 * 每次提交应仅包含少量且相关的变更,避免一次性提交过多内容,以便于追踪和管理。 @@ -386,7 +387,7 @@ flowchart LR * **描述清晰**:避免模糊描述,如“修复报错”;应写明“修复用户登录时因 token 校验失败导致的 500 错误”。 * **一个 Issue 只包含一个问题**:避免一个 Issue 同时涉及多个 Bug 或功能需求。 * **保持更新**:在处理过程中,及时补充进展,方便团队成员了解状态。 -* **结合 Milestone**:将 Issue 归档到迭代或版本里,保证任务有明确的交付目标。 +* **关联 Milestone**:将 Issue 关联 Milestone,保证任务有明确的交付目标。 ```mermaid @@ -399,8 +400,6 @@ flowchart LR A -.-> A1(明确问题/需求,背景、预期、实际) A -.-> A2(必要时截图/日志/代码) B -.-> B1(分配给具体开发者) - B -.-> B2(复杂 Issue 可先评估拆分) - C -.-> C1(新建分支并关联 Issue) C -.-> C2(PR 关联 Issue) D -.-> D1(PR 合并前关闭 Issue) D -.-> D2(未解决可重开或新建) @@ -427,7 +426,7 @@ flowchart LR * **标题**:使用统一格式,例如 `v1.0.0`。 * **描述**:简要说明该里程碑的目标和范围。 - * **截止日期**:设定完成时间,帮助团队明确交付周期。 + * **截止日期**:设定完成时间,帮助团队明确交付周期(可选)。 ### 7.3 使用规范 @@ -525,8 +524,6 @@ flowchart LR | `In Progress` | 正在进行的任务 | 功能开发、Bug 修复 | | `Done` | 已完成任务 | 已合并 PR、完成的文档更新 | -> 团队可在必要时新增列,例如 `Blocked`、`QA`,但推荐保持简洁。 - ### 8.4 使用规范 @@ -608,4 +605,6 @@ flowchart LR class T todo class P progress class D done -``` \ No newline at end of file +``` + +