感谢参与 WeMail 的开发。
docs/README.mddocs/code-standard.mddocs/development-workflow.mddocs/testing-strategy.md- 如涉及部署或配置,再看
docs/deploy-runbook.md
- 不要直接在
main上做长期开发 - 先确认目录职责,再写代码
- 结构变更必须同步更新 README / docs
- 每次提交都必须同步更新根目录
CHANGELOG.md - 优先小步修改,保持 diff 可审查
- 不要把生成产物、缓存目录、临时日志提交进仓库
feature/<topic>fix/<topic>refactor/<topic>docs/<topic>
提交信息遵循 Lore Commit Protocol:
- 第一行写“为什么”
- 正文说明约束、方案、取舍
- trailers 记录验证、风险和 rejected alternatives
提交前至少运行:
pnpm test
pnpm typecheck
pnpm lint
pnpm build提交前还要确认根目录 CHANGELOG.md 已记录本次提交对应的 [Unreleased] 或 release 变更。
其他评审要求、版本规则、文档联动规则、补充验证范围,以 docs/development-workflow.md 和 docs/testing-strategy.md 为准。
- 说明变更目的
- 说明影响范围
- 提供验证结果
- 说明剩余风险和后续工作