SikongJueluo/Mini-Nav
1
0
Fork 0
mirror of https://github.com/SikongJueluo/Mini-Nav.git synced 2026-03-12 12:25:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): update test principle for development

Browse Source
This commit is contained in:
SikongJueluo
2026-02-07 11:08:13 +08:00
parent 0b10ab6cfa
commit aa6baa87fe
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
DEVELOPMENT.md
View File

@@ -5,8 +5,7 @@
### Google风格代码 ### Google风格代码
详细参阅：https://raw.githubusercontent.com/shendeguize/GooglePythonStyleGuideCN/refs/heads/master/README.md 详细参阅：https://raw.githubusercontent.com/shendeguize/GooglePythonStyleGuideCN/refs/heads/master/README.md
### 代码编写要求 ### 代码编写原则
编写的代码要求：
- 简洁，清晰易懂，最小化实现 - 简洁，清晰易懂，最小化实现
- 条件或循环分支不能超过三层，提前Return以减少分支的出现 - 条件或循环分支不能超过三层，提前Return以减少分支的出现
- 变量说明注释、条件或循环分支注释完全 - 变量说明注释、条件或循环分支注释完全
@@ -14,6 +13,13 @@
- 先编写测试集，再实现代码 - 先编写测试集，再实现代码
- 实现测试集后，先询问意见，在用户修改完成测试集后再实现代码 - 实现测试集后，先询问意见，在用户修改完成测试集后再实现代码
### 测试编写原则
- 精简、干净、快速
- 核心关键逻辑或算法必须测试
- 无需编写测试集的情况
- UI界面相关的代码
- 过于复杂或耗时的逻辑
### 文档更新说明 ### 文档更新说明
仅在工程目录变化时，更新此文档的目录说明部分。 仅在工程目录变化时，更新此文档的目录说明部分。
如需修改其他部分，请先询问，在进行修改。 如需修改其他部分，请先询问，在进行修改。
@@ -34,4 +40,4 @@
### Python库 ### Python库
详细查询pyproject.toml或使用`uv pip list`获取详细的库信息，请基于目前的库实现功能。 详细查询pyproject.toml或使用`uv pip list`获取详细的库信息，请基于目前的库实现功能。
如需添加新库，请先询问，再新增。 如需添加新库，请先询问，再新增。