veops/cmdb项目贡献指南：从代码提交到协作规范

veops/cmdb项目贡献指南：从代码提交到协作规范

项目概述

veops/cmdb是一个配置管理数据库(Configuration Management Database)项目，主要用于IT基础设施的配置项管理。作为IT运维领域的核心系统，CMDB能够帮助组织有效管理硬件、软件、网络设备等各种配置项及其相互关系。

开发环境准备

在开始贡献代码前，需要确保本地开发环境满足以下要求：

1. Python环境：版本不低于3.8，建议使用虚拟环境管理工具如venv或conda
2. Node.js环境：版本不低于14.17.6，用于前端开发
3. Docker：用于容器化部署和测试

代码提交流程详解

1. 问题识别与确认

在提交代码修改前，建议先确认问题是否已被记录或正在处理。对于bug修复，应当先创建问题描述；对于新功能开发，建议先与核心团队沟通设计思路。

2. 分支管理策略

采用功能分支工作流，具体步骤如下：

# 创建并切换到新功能分支
git checkout -b feat/your-feature-name

# 开发完成后提交变更
git commit -am 'feat: 添加xxx功能'

# 推送分支到远程仓库
git push origin feat/your-feature-name

3. 提交Pull Request

推送分支后，可以创建合并请求。注意以下几点：

• 源分支应为你的功能分支
• 目标分支应为项目的主分支
• 提供清晰的修改说明和背景信息

代码规范要求

Python后端规范

遵循Google Python风格指南，主要要点包括：

• 使用4个空格缩进
• 导入语句分组并按特定顺序排列
• 类名使用驼峰命名法
• 函数名使用小写加下划线
• 适当的文档字符串

前端JavaScript规范

遵循Node.js风格指南，重点包括：

• 使用2个空格缩进
• 使用单引号
• 严格使用分号
• 一致的命名约定

提交信息规范

采用Angular提交规范，格式为：

类型(范围): 简短描述

详细描述（可选）

相关Issue（可选）

常用提交类型说明

| 类型 | 用途说明 | |------------|----------------------------| | feat | 新增功能 | | fix | 修复bug | | docs | 文档更新 | | style | 代码格式调整 | | refactor | 代码重构 | | test | 测试相关 | | chore | 构建过程或辅助工具变更 |

代码内容规范

为确保项目可维护性，所有代码内容需遵循以下规范：

1. 注释要求：关键算法和复杂逻辑必须添加清晰注释
2. 命名规范：使用有意义的英文命名
3. 模块化设计：保持功能模块的高内聚低耦合
4. 测试覆盖：新功能应包含相应单元测试

协作建议

1. 定期同步：定期拉取主分支变更，避免合并冲突
2. 小步提交：每次提交聚焦单一功能或修复
3. 清晰沟通：在提交描述中提供足够上下文信息
4. 代码审查：积极参与他人代码的审查讨论

通过遵循这些规范，可以确保项目保持高质量和可维护性，同时使协作过程更加顺畅高效。