Просмотр исходного кода

docs: 优化Git工作流程文档,添加自动更新CHANGELOG步骤

- 添加自动更新CHANGELOG.md的步骤说明,确保每次提交都记录变更历史
- 调整步骤顺序:先更新CHANGELOG.md(第3步),再更新package.json版本(第4步)
- 明确CHANGELOG条目格式要求:标题需包含日期和时间(如 ## [1.8.0] - 2025-12-15 16:14)
- 优化步骤编号,确保文档结构更加清晰合理

改动文件:
- .clinerules/workflows/git-commit-and-push.md
- CHANGELOG.md
dengdx 4 недель назад
Родитель
Сommit
7f792b0933
2 измененных файлов с 24 добавлено и 3 удалено
  1. 4 3
      .clinerules/workflows/git-commit-and-push.md
  2. 20 0
      CHANGELOG.md

+ 4 - 3
.clinerules/workflows/git-commit-and-push.md

@@ -36,9 +36,10 @@ Automate the Git commit and push process by intelligently analyzing file changes
      - `feat: add new workflow creation process in .clinerules/workflows/create-new-workflow.md`
      - `fix: resolve authentication issue in src/API/security/userActions.ts`
      - `docs: update README.md with installation instructions`
-3. Based on the commmit message type ,such as feat , or fix .etc. you should change the version in the package.json file which is located in the project directory 
-3. Ensure the commit message is descriptive and includes relevant file paths for clarity.
-4. Ensure the commit message contains modified files which are changed or new added files . the commit message should be in Chinese  . the files list locates below the commit message and contribute to the commit messsage. Examplse :
+3. Based on the file changes , a new changelog item should be appended in the changelog.md file ,and the new content should be put at the top to ensuer it is the first changelog item , as to the content , you can refer the changelog.md file , and make sure the title should contain date and time such as  ## [1.8.0] - 2025-12-15 16:14
+4. Based on the commmit message type ,such as feat , or fix .etc. you should change the version in the package.json file which is located in the project directory 
+5. Ensure the commit message is descriptive and includes relevant file paths for clarity.
+6. Ensure the commit message contains modified files which are changed or new added files . the commit message should be in Chinese  . the files list locates below the commit message and contribute to the commit messsage. Examplse :
     `feat: 实现曝光模式切换功能并集成设备API下发
 
     - 在 APRActions.ts 中导出 setExposureModeFromAction API

+ 20 - 0
CHANGELOG.md

@@ -5,6 +5,26 @@
 格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/),
 版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
 
+## [1.8.0] - 2025-12-15 16:47
+
+### 变更 (Changed)
+- **Git工作流程文档优化** ([.clinerules/workflows/git-commit-and-push.md](.clinerules/workflows/git-commit-and-push.md))
+  - 添加自动更新CHANGELOG.md的步骤说明,确保每次提交都记录变更历史
+  - 调整步骤顺序:先更新CHANGELOG.md(第3步),再更新package.json版本(第4步)
+  - 明确CHANGELOG条目格式要求:标题需包含日期和时间(如 ## [1.8.0] - 2025-12-15 16:14)
+  - 优化步骤编号,确保文档结构更加清晰合理
+
+**核心改进:**
+- 规范化提交流程,确保变更历史完整记录
+- 新增CHANGELOG条目始终放在顶部,便于查看最新变更
+- 提高文档可维护性,为自动化工作流提供明确指导
+
+**改动文件:**
+- .clinerules/workflows/git-commit-and-push.md
+- CHANGELOG.md
+
+---
+
 ## [1.8.0] - 2025-12-15 16:36
 
 ### 变更 (Changed)