name: project_culture description: 基于 MultiversX 标准评估代码成熟度(文档存在性、测试文化)。
项目文化与代码成熟度指数
本技能帮助您基于“异味”和文化指标来评估代码库的质量和可靠性。
1. 文档质量
- 文档存在性: 是否有
README.md?它是否解释了如何构建和测试? - MultiversX 特定项:
mxpy.json: 表示使用标准构建工具。snippets.sh或interaction/: 用于部署/交互的脚本。
- 规格说明: 在
specs/或whitepaper/中是否有.md文件?
2. 测试文化
- 单元测试: 运行
cargo test。是否有测试?它们是否覆盖边缘情况或只是“快乐路径”? - 集成测试: 查找
scenarios/(Mandos)。- 黄金标准:
scen.json文件覆盖每个端点。 - 红旗: 没有场景,或只有
deployment.scen.json。
- 黄金标准:
- 模拟: 在 CI 或脚本中是否提到
mx-chain-simulator-go?
3. 代码卫生
- 代码检查器:
cargo clippy是否通过? - 魔法数字: 是否有原始整数(例如,
86400)而不是命名常量(SECONDS_PER_DAY)? - 注释: 复杂的代码块是否有解释?
- 解包: 过度使用
unwrap()而不是sc_panic!或检查?
4. 依赖管理
- 锁定文件: 是否提交了
Cargo.lock? - 版本固定:
multiversx-sc版本是否被固定或使用通配符*?(通配符不好)。
评分(心智模型)
- 高成熟度: 完整的 Mandos 覆盖、详细的规格说明、清洁的 clippy、固定的版本。 -> 审计重点: 业务逻辑缺陷。
- 低成熟度: 没有测试、意大利面条式代码、到处使用
unwrap()。 -> 审计重点: 基本安全性、重入、算术溢出、拒绝服务。