跳到主要内容

井云服务中心开发规范

本目录统一管理井云服务中心项目的所有开发规范，确保团队遵循统一的技术标准。项目基于 Go 1.25.4 和 Kratos v2 框架，采用微服务架构设计。

📁 规范目录​

standards/
├── README.md                  # 规范总览
├── proto_style_guide.md       # Protocol Buffers 样式指南
├── testing_guide.md           # 测试规范和指南
├── git_workflow_guide.md      # Git 工作流规范
├── error-handling-guide.md    # 错误处理规范
├── security-design.md         # 安全设计文档
└── database-design.md         # 数据库设计规范

📋 规范说明​

🔧 开发规范​

  • proto_style_guide.md - Protocol Buffers 编写规范

    • 命名约定和消息结构设计
    • 字段编号规则和注释规范
    • HTTP 路由和验证规则

  • testing_guide.md - 测试代码编写规范

    • 测试分层策略和覆盖率要求
    • Mock 使用规范和测试模式
    • Gateway 和数据库服务测试差异

  • git_workflow_guide.md - Git 工作流规范

    • 分支管理策略
    • 提交信息规范（Conventional Commits）
    • 代码审查流程

🛡️ 质量规范​

  • error-handling-guide.md - 错误处理规范

    • 错误码分段规则和映射关系
    • 异常处理机制和日志规范
    • 前端错误处理指南

  • security-design.md - 安全设计文档

    • 鉴权授权模型和 Token 管理
    • 敏感数据处理和加密策略
    • 审计日志和防重放机制

  • database-design.md - 数据库设计规范

    • 表结构设计和索引策略
    • 数据迁移和保留策略
    • 性能优化最佳实践

🔗 使用指南​

开发者必读​

  1. 新手入门: 先阅读 proto_style_guide.md 了解 API 设计规范
  2. Git 工作流: 遵循 git_workflow_guide.md 进行版本控制
  3. 编写测试: 参考 testing_guide.md 编写高质量测试代码

维护者指南​

  1. 更新规范: 当引入新功能或改变架构时，及时更新相关规范
  2. 版本控制: 规范变更需要团队讨论和评审

📝 贡献指南​

如需添加新的规范文档：

  1. 创建新的 .md 文件
  2. 遵循现有的命名规范
  3. 包含清晰的适用范围和示例
  4. 更新本 README.md 文件
  5. 在团队中评审和推广

🚀 相关资源​

注意: 规范是项目质量的基石，请严格遵守并持续改进。