TemplateProject/CONTRIBUTING.md

贡献指南

感谢你对本项目的关注！请遵循以下规范参与开发。

开发流程

1. 认领任务 — 从 docs/implementation/tasks/ 中选取或创建任务
2. 创建分支 — 分支命名：feature/<描述> / fix/<描述> / docs/<描述>
3. 编写代码 — 遵循项目代码规范，添加必要的测试
4. 自测 — 确保测试通过，功能正常
5. 提交代码 — Commit message 遵循 约定式提交
6. 发起 Merge Request / Pull Request — 描述变更内容，关联对应的需求/问题
7. 代码审查 — 至少一人 Review 通过后合并

Commit Message 规范

<type>(<scope>): <subject>

类型（type）：
  feat     — 新功能
  fix      — 修复
  docs     — 文档
  style    — 格式（不影响功能）
  refactor — 重构
  test     — 测试
  chore    — 构建/工具

示例：
  feat(auth): add login by SMS
  fix(api): correct user list pagination

代码规范

• 保持代码风格与项目一致
• 公共接口必须有注释
• 新增功能必须编写测试
• 修改现有功能需同步更新相关文档

测试要求

• 单元测试覆盖率目标：> [XX]%
• 提交前确保所有测试通过
• 涉及接口变更需补充集成测试

文档要求

• 功能设计文档放在 docs/features/
• 架构变更需在 docs/design/architecture/ 添加 ADR（架构决策记录）
• 需求变更在 docs/requirements/changes/ 记录