docs: git-workflow v1.1 与 CODEOWNERS 规范
- git-workflow.md v1.1: scope-enum 对齐实际服务名(identity→iam 等) - git-workflow.md: 新增 §4.7 模块 Owner 与 CODEOWNERS 章节 - git-workflow.md: husky hooks 与实际文件对齐,新增 pre-push 说明 - .github/CODEOWNERS: 定义各模块 owner team 与 PR 合并职责 - .github/pull_request_template.md: PR 模板
This commit is contained in:
80
.github/CODEOWNERS
vendored
Normal file
80
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,80 @@
|
||||
# Edu 平台 CODEOWNERS
|
||||
# 格式:路径 @owner
|
||||
# 作用:GitHub/Gitea 自动为 PR 分配 reviewer
|
||||
# 维护规则:
|
||||
# 1. 新增服务/包时,必须同步更新本文件
|
||||
# 2. owner 变更需开独立 PR,由架构组审批
|
||||
# 3. 与 docs/standards/git-workflow.md §4.7 保持同步
|
||||
# Team handle 占位符:@edu-platform/* 需在 Organization 中创建对应 team 后替换
|
||||
|
||||
# ===== 架构与规则(架构组,2 人 review)=====
|
||||
/.trae/ @edu-platform/arch
|
||||
/docs/architecture/ @edu-platform/arch
|
||||
/docs/standards/ @edu-platform/arch
|
||||
/scripts/arch-scan/ @edu-platform/arch
|
||||
|
||||
# ===== 根配置(架构组,2 人 review,影响全局)=====
|
||||
/.commitlintrc.js @edu-platform/arch
|
||||
/lint-staged.config.js @edu-platform/arch
|
||||
/package.json @edu-platform/arch
|
||||
/pnpm-workspace.yaml @edu-platform/arch
|
||||
/go.work @edu-platform/arch
|
||||
/pyproject.toml @edu-platform/arch
|
||||
/tsconfig.base.json @edu-platform/arch
|
||||
|
||||
# ===== 共享包(架构组,2 人 review,契约变更影响所有服务)=====
|
||||
/packages/shared-proto/ @edu-platform/arch
|
||||
/packages/shared-ts/ @edu-platform/arch
|
||||
/packages/shared-go/ @edu-platform/arch
|
||||
/packages/shared-py/ @edu-platform/arch
|
||||
/packages/shared-tokens/ @edu-platform/arch
|
||||
|
||||
# ===== 网关层(Go)=====
|
||||
/services/api-gateway/ @edu-platform/gateway
|
||||
/services/push-gateway/ @edu-platform/gateway
|
||||
|
||||
# ===== 业务微服务 =====
|
||||
# IAM(核心模块,2 人 review)
|
||||
/services/iam/ @edu-platform/iam
|
||||
# 教学核心
|
||||
/services/core-edu/ @edu-platform/edu-core
|
||||
/services/classes/ @edu-platform/edu-core
|
||||
# 内容资源
|
||||
/services/content/ @edu-platform/content
|
||||
# 消息通知
|
||||
/services/msg/ @edu-platform/messaging
|
||||
# 数据分析(Python)
|
||||
/services/data-ana/ @edu-platform/data
|
||||
# AI 网关(Python)
|
||||
/services/ai/ @edu-platform/ai
|
||||
|
||||
# ===== BFF 聚合层(NestJS)=====
|
||||
/services/teacher-bff/ @edu-platform/edu-core
|
||||
/services/student-bff/ @edu-platform/edu-core
|
||||
/services/parent-bff/ @edu-platform/edu-core
|
||||
|
||||
# ===== 微前端(Next.js)=====
|
||||
/apps/teacher-portal/ @edu-platform/frontend
|
||||
/apps/student-portal/ @edu-platform/frontend
|
||||
/apps/parent-portal/ @edu-platform/frontend
|
||||
/apps/admin-portal/ @edu-platform/frontend
|
||||
|
||||
# ===== 基础设施(SRE,2 人 review,生产环境变更强制)=====
|
||||
/infra/k8s/ @edu-platform/sre
|
||||
/infra/backup/ @edu-platform/sre
|
||||
/infra/security/ @edu-platform/sre
|
||||
/infra/monitoring/ @edu-platform/sre
|
||||
/infra/docker-compose*.yml @edu-platform/sre
|
||||
|
||||
# ===== CI/CD(SRE)=====
|
||||
/.github/ @edu-platform/sre
|
||||
/.husky/ @edu-platform/sre
|
||||
|
||||
# ===== 文档(架构组)=====
|
||||
/docs/troubleshooting/ @edu-platform/arch
|
||||
/MIGRATION_GUIDE.md @edu-platform/arch
|
||||
/README.md @edu-platform/arch
|
||||
/CHANGELOG.md @edu-platform/arch
|
||||
|
||||
# ===== 兜底(未匹配的文件由架构组 review)=====
|
||||
* @edu-platform/arch
|
||||
55
.github/pull_request_template.md
vendored
Normal file
55
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
## 变更说明
|
||||
|
||||
<!-- 简述本次变更的目的和实现方式 -->
|
||||
|
||||
## 变更类型
|
||||
|
||||
- [ ] feat: 新功能
|
||||
- [ ] fix: Bug 修复
|
||||
- [ ] perf: 性能优化
|
||||
- [ ] refactor: 重构
|
||||
- [ ] test: 测试
|
||||
- [ ] docs: 文档
|
||||
- [ ] build/ci: 构建/CI
|
||||
- [ ] chore: 杂项
|
||||
|
||||
## 影响范围
|
||||
|
||||
<!-- 列出受影响的服务/包 -->
|
||||
|
||||
- 服务:
|
||||
- 包:
|
||||
- 数据库迁移:是 / 否
|
||||
- protobuf 契约变更:是 / 否(如变更是否向后兼容)
|
||||
- Kafka topic 变更:是 / 否
|
||||
- 架构文档变更:是 / 否
|
||||
|
||||
## 测试情况
|
||||
|
||||
- [ ] 单元测试通过
|
||||
- [ ] 集成测试通过
|
||||
- [ ] 本地手动测试通过
|
||||
- [ ] 新增测试覆盖新功能
|
||||
|
||||
### 按语言的校验结果
|
||||
|
||||
- TS 服务:`pnpm run lint` + `pnpm run typecheck`(如缺失脚本请说明)
|
||||
- Go 服务:`go vet ./...` + `go build ./...`
|
||||
- Python 服务:`ruff check src/`
|
||||
|
||||
## 文档同步
|
||||
|
||||
- [ ] 已更新服务 README(如涉及服务结构变更)
|
||||
- [ ] 已更新架构文档(如涉及架构变更)
|
||||
- [ ] 已运行 `pnpm run arch:scan` 更新 arch.db(arch.db 不入库,但本地验证必须通过)
|
||||
- [ ] 已更新 `docs/troubleshooting/known-issues.md`(如遇到新问题/经验)
|
||||
- [ ] 已更新 `.github/CODEOWNERS`(如新增服务/包)
|
||||
|
||||
## Breaking Change
|
||||
|
||||
- [ ] 否
|
||||
- [ ] 是(请在下方说明影响和迁移路径)
|
||||
|
||||
## 关联 Issue
|
||||
|
||||
Closes #
|
||||
Reference in New Issue
Block a user