每次实现任务完成后,必须运行 Clippy 检查代码:
cargo clippy -- -D warnings在以下情况下必须执行:
- 完成任何功能实现后
- 完成任何 bug 修复后
- 完成代码重构后
- 提交代码前
如果 Clippy 报告错误或警告,必须修复后再继续。
每次实现新功能或修改现有功能后,必须为相关的 public 函数编写单元测试:
- 测试文件放在各模块的
#[cfg(test)]块中 - 每个 public 函数至少有一个对应的测试用例
- 测试必须通过才能继续
# 运行所有测试
cargo test
# 运行特定模块测试
cargo test <module>::tests# 代码检查
cargo clippy -- -D warnings
# 运行测试
cargo test
# 构建
cargo build --release每次发布新版本前,必须更新 Cargo.toml 中的版本号:
[package]
version = "0.4.0" # 更新为新版本号发布步骤:
- 更新 Cargo.toml 版本号
- 提交代码并推送(必须包含 openspec 目录的变更)
- 创建 tag 并推送:
git tag v0.4.0
git push origin v0.4.0GitHub Actions 会自动构建并发布。
注意: 提交代码时必须同时提交 openspec/ 目录下的所有变更,包括:
openspec/changes/- 变更提案和设计文档openspec/specs/- 功能规格文档
每次使用 /opsx:archive 归档变更提案后,必须审视这次变更是否需要更新 README.md:
| 变更类型 | 是否需要更新 README.md |
|---|---|
| 新功能(如新增 CLI 命令) | 需要 |
| 配置参数变更(新增/修改/删除配置项) | 需要 |
| Bug 修复 | 不需要 |
| 内部逻辑优化(不涉及配置或使用方式变更) | 不需要 |
- 用户需要感知:用户需要了解、配置或使用的新内容
- 用户无需感知:用户直接受益但不需知道的内部改进
如果判断需要更新 README.md,则在归档前完成文档更新。