mirror of https://github.com/ArvinLovegood/go-stock.git synced 2025-07-19 00:00:09 +08:00

ArvinLovegood 645c6979a4 docs: 添加 Pull Request 模板

添加了 .github/pull_request_template.md 文件，用于规范 Pull Request 的提交信息。模板包含了以下内容：
- PR 概述
- 相关问题
- 改动内容详细说明（代码修改、新增功能、删除内容）
-测试情况（单元测试、集成测试）
- 注意事项
- 其他补充说明

此模板有助于提高 PR 的质量和可审查性，确保开发者在提交 PR 时提供足够的信息。

2025-02-27 13:59:09 +08:00

2.2 KiB

Raw Blame History

Pull Request 信息

本次 PR 概述

请简要描述这个 Pull Request 做了什么改动。例如：

修复了某个特定功能的 bug
实现了一个新的功能特性
对代码进行了优化，提升了性能

改动内容详细说明

代码修改

列出主要修改的文件和修改点。例如：
- app_linux.go：
  - 修改了函数 GetStockList 的逻辑，从使用 for 循环改为 sum 函数，提升了计算效率。
- app_test.go：
  - 新增了针对 GetStockList 函数的单元测试，确保修改后的逻辑正确。

新增功能

如果有新增功能，请详细描述该功能的使用方法和特点。例如：

新增了一个用户认证模块，支持使用用户名和密码进行登录。使用方法如下：
- 调用 authenticate_user(username, password) 函数进行认证。
- 若认证成功，返回 True；否则返回 False。

删除内容

如果有删除的代码或文件，请说明删除的原因。例如：

删除了 app_test.go 文件，因为该模块的功能已经被新的模块替代，不再需要。

测试情况

单元测试

列出运行的单元测试以及测试结果。例如：
- 运行了 app_test.go 进行单元测试，所有测试用例均通过。
- 测试覆盖率达到了 90%。

集成测试

如果进行了集成测试，请描述测试环境和测试结果。例如：

在本地开发环境（Wails CLI v2.10.1 node v18.19.1 ）中进行了集成测试，功能正常。
在 CI/CD 环境中也进行了测试，所有步骤均通过。

注意事项

提醒其他开发者在审查代码时需要注意的地方。例如：
- 本次修改涉及到数据库表结构的变更，请确保在部署前进行数据库迁移。
- 新增的功能依赖于第三方库 requests，请确保在环境中安装该库。

其他补充说明

可以在这里提供任何其他需要说明的信息，例如设计文档的链接、相关讨论的记录等。

2.2 KiB Raw Blame History Unescape Escape