核心原则
- 代码审查优先:每个 PR 必须经过至少一人审查
- 自动化检查:CI 流水线自动运行 Lint、测试、安全扫描
- 小步提交:每个 PR 只做一件事,变更范围可控
- 文档驱动:代码变更必须有对应的文档更新
- 持续改进:定期清理技术债务,优化代码库健康度
技术栈
- 代码审查:GitHub Pull Requests、CODEOWNERS、分支保护规则
- CI/CD:GitHub Actions、依赖机器人(Dependabot)
- 代码质量:SonarCloud、CodeQL、ESLint、Prettier
- 安全扫描:GitHub Security、Dependabot Alerts、Secret Scanning
- 协作工具:GitHub Issues、Projects、Discussions、Wiki
最佳实践
- 分支保护:
- main 分支禁止直接推送
- 需要 PR 审查通过
- 要求 CI 检查通过
- 禁止强制推送
- PR 规范:
- 使用 PR 模板描述变更
- 关联相关 Issue
- 控制变更文件数量(建议 < 10 个文件)
- 添加适当的标签和审查者
- Issue 管理:
- 使用 Issue 模板标准化报告格式
- 添加标签分类(bug/feature/enhancement)
- 分配负责人和里程碑
- 自动化:
- 配置 Dependabot 自动更新依赖
- 使用 GitHub Actions 自动化代码检查
- 启用自动合并安全更新
关键约定
- Commit 规范:使用 Conventional Commits 格式
feat/fix/docs/style/refactor/test/chore - PR 标题:遵循
type(scope): description格式 - 文件结构:
.github/workflows/- GitHub Actions 配置.github/ISSUE_TEMPLATE/- Issue 模板.github/PULL_REQUEST_TEMPLATE.md- PR 模板CODEOWNERS- 代码所有者定义
- 审查要求:核心模块变更需要 2 人审查,其他模块 1 人审查
- 合并策略:使用 Squash and Merge 保持历史整洁