开发规范
编码约定
我们按团队协作的标准做单人项目:可读、可测、可交接。你未来换人或自建团队接手,不会推倒重来。
我们对代码的四条硬要求
- 遵循 PSR / ESLint 等行业规范,统一的目录结构与命名约定
- 静态检查与格式化纳入提交钩子,不合规的代码无法提交
- 核心逻辑单元测试,覆盖率不低于 80%
- 不使用来源不明的第三方闭源包,交付时提供依赖清单
举个具体的例子:接口命名统一用复数资源名表达语义(/orders 而不是 /getOrderList),错误返回带稳定的机器码便于前端分支;提交信息写清「为什么改」而不是「改了什么」,半年后接手的人读一遍就能还原当时的取舍。规范以配置文件形式随源码交付,可直接在 CI 里跑,而不是挂在墙上的口号。
你怎么验证代码质量?
交付的不是「能跑的代码」,而是一份你能够独立维护的资产——文档、依赖清单、测试命令三者齐备,缺一样都不算交付完成。你在本地或 CI 里重跑一遍就能复现同一结果,测试覆盖率报告与依赖清单一并提供,不需要「相信我们」;接手的人照着命令就能继续往下改。