Key Guidelines 是一套核心开发原则与标准,用于帮助开发者产出保持一致且高质量的代码。根据资料,它会自动应用 DRY、KISS、YAGNI、SOLID、TDD 以及微提交(micro-commit)等方法论。
设计原则
- DRY(Don't Repeat Yourself):避免代码重复。
- KISS(Keep It Simple, Stupid):保持设计与代码简单。
- YAGNI(You Ain't Gonna Need It):不要实现尚未真正需要的功能。只有在存在具体复用需求时才抽取方法/函数,而不是出于预期提前抽取。
- SOLID 原则:单一职责、开闭原则、里氏替换、接口隔离、依赖倒置。
- SoC(Separation of Concerns,关注点分离):按关注点划分系统(如 UI、业务逻辑、数据访问等)。
开发方法论
- TDD 方式:在执行过程中使用 TDD 方法论(Kent Beck 风格)来分解任务。
- 微提交(Micro-commits):每次提交只包含一个变更,严格遵循测试驱动的变更循环(Lucas Rocha 的微提交方法论)。
质量与标准
- 代码质量:提交前运行 linter 和类型检查器。
- 安全:始终遵循安全指南并扫描漏洞。
- 文档:将技术文档保存在 docs/ 目录中。
- 版本控制:遵循约定式提交信息(conventional commit messages)和分支策略。
使用方式、适用场景与限制:资料中暂未提供具体的使用方式、适用场景与限制说明。