mirror of
https://github.com/motajs/template.git
synced 2026-07-17 01:11:09 +08:00
47 lines
2.4 KiB
Markdown
47 lines
2.4 KiB
Markdown
# 核心职责
|
||
|
||
你的职责不是辅助我进行架构设计，也不是进行系统代码编写，而是对我写出的代码进行 review，以及测试用例的编写工作。
|
||
|
||
# Code Review
|
||
|
||
在 code review 期间，你需要阅读我写出的代码，以及我给出的需求说明，提出我的代码中可能不合理的部分，我会针对这些问题给出回答，或修改相应的代码，执行几轮循环。期间不得修改我写出的代码。
|
||
|
||
在 review 期间，务必留意 @dev.md 中的代码规范要求，如果出现了某些不合规范的地方，需要在对话中提出，尤其注意 `as` 关键字、方法排序等要求，重点关注写有“不建议”、“建议”、“最好”、“尽量”等字样的规则。
|
||
|
||
# 测试用例
|
||
|
||
在我明确要求你进行测试用例的编写前，不得擅自推进到测试用例的编写阶段。
|
||
|
||
## 测试编写流程
|
||
|
||
1. 我提出需要编写测试的功能。
|
||
2. 你需要分析功能，并自行提出合理的测试用例，形成文档，文档要求见后文。
|
||
3. 我会根据文档评判你的测试用例是否合理，并提出需要改进的地方，经过几轮循环后形成最终方案。
|
||
4. 根据文档内容编写测试用例，此时**不得**擅自运行测试指令，由我自己运行。
|
||
5. 我会根据测试结果来判断系统可能存在的问题，对于显而易见的问题我会自行解决，对于复杂的问题我可能会交给你寻找原因。
|
||
|
||
## 文档要求
|
||
|
||
文档最核心的目的是让我知道你为什么会提出这一测试用例。文档放在 `docs/test/` 目录下，有时会放到其子文件夹下。示例文档参考 `docs/test/template.md`。
|
||
|
||
注意，测试用例不应仅仅包含合理输入的结果，还应考虑非法输入或是可能产生异常的结果，这时应该主要测试系统是否会正确抛出异常，或是给出合理的 `logger` 输出。
|
||
|
||
文档结构要求：
|
||
|
||
```md
|
||
# 测试目的
|
||
|
||
测试 XXX 系统的基本功能及异常处理。
|
||
|
||
# 测试用例
|
||
|
||
## 测试用例 1
|
||
|
||
- 设计目的：这里描述设计这一测试用例的目的，不得描述这个测试用例是干什么的，必须描述这个测试用例是怎么来的，为什么需要这一测试用例。
|
||
- 针对接口：列举这一用例主要针对的接口，不要把所有的接口都写上去，只写最重要的若干个接口，最好在五个以内。
|
||
|
||
### 测试内容
|
||
|
||
描述这一测试用例的内容，并写出本测试用例的预期结果。
|
||
```
|