ITOps Agent Platform

主题

Contributing to ITOps Agent Platform ​

感谢你对 ITOps Agent Platform 项目的关注！我们欢迎任何形式的贡献，包括但不限于：

  • 提交 Bug 报告
  • 提出新功能建议
  • 提交代码修复或功能实现
  • 改进文档
  • 翻译本地化

📋 目录 ​

行为准则 ​

本项目采用 Contributor Covenant 行为准则。参与本项目即表示你同意遵守其条款。

开发环境搭建 ​

前置要求 ​

  • Node.js >= 18.0.0
  • npm >= 9.0.0
  • Git
  • Docker & Docker Compose（可选，用于容器化部署）

本地开发 ​

bash
# 1. Fork 并克隆仓库
git clone https://github.com/YOUR_USERNAME/itops-agent-platform.git
cd itops-agent-platform

# 2. 安装依赖
npm run install:all

# 3. 配置环境变量
cp .env.example .env

# 4. 启动开发服务器
npm run dev

详细开发环境搭建请参考 开发指南。

提交 Bug ​

提交 Bug 时，请提供以下信息：

  1. 清晰的标题：简要描述问题
  2. 复现步骤：详细说明如何触发问题
  3. 预期行为：你认为应该发生什么
  4. 实际行为：实际发生了什么
  5. 环境信息：
    • 操作系统及版本
    • Node.js 版本
    • 浏览器及版本（前端问题）
    • Docker 版本（部署问题）
  6. 日志信息：相关错误日志（如有）
  7. 截图或录屏：UI 问题请附上截图

提交 Bug →

提出新功能 ​

提出新功能时，请说明：

  1. 功能描述：你想实现什么功能
  2. 使用场景：这个功能解决什么问题
  3. 实现思路：如果你有技术实现方案，欢迎分享
  4. 替代方案：是否有其他方式可以解决

提出新功能 →

提交 Pull Request ​

准备工作 ​

  1. Fork 本仓库
  2. 创建你的功能分支：git checkout -b feat/your-feature-name
  3. 在你的分支上进行修改

提交代码 ​

  1. 遵循代码风格：请参考 代码风格
  2. 遵循 Git 提交规范：请参考 Git 提交规范
  3. 更新文档：如果你的修改涉及功能变更，请同步更新相关文档
  4. 测试通过：确保所有测试通过
bash
# 运行测试
cd backend && npm test

# 运行 Lint
npm run lint
  1. 提交 PR：推送到你的 Fork 并创建 Pull Request

PR 要求 ​

  • PR 标题遵循 Conventional Commits 规范
  • 详细描述修改内容、修改原因和测试方法
  • 如果修复了 Issue，请在 PR 描述中关联相关 Issue（如 Fixes #123）
  • 保持 PR 的改动尽可能小，一个 PR 只做一件事

代码风格 ​

TypeScript ​

  • 遵循项目现有的代码风格
  • 使用 TypeScript 严格模式
  • 变量和函数命名使用 camelCase
  • 类和接口命名使用 PascalCase
  • 常量命名使用 UPPER_CASE

React ​

  • 函数组件优先于类组件
  • 使用 Hooks 管理状态和副作用
  • 组件命名使用 PascalCase
  • Props 类型定义完整

后端 ​

  • 路由文件统一放在 backend/src/routes/
  • 业务逻辑放在 backend/src/services/
  • 中间件放在 backend/src/middleware/
  • 工具函数放在 backend/src/utils/

前端 ​

  • 页面组件放在 frontend/src/pages/
  • 通用组件放在 frontend/src/components/
  • 自定义 Hooks 放在 frontend/src/hooks/
  • API 调用封装在 frontend/src/lib/api.ts

Git 提交规范 ​

所有提交必须遵循 Conventional Commits 规范：

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

type 可选值：

  • feat: 新功能
  • fix: Bug 修复
  • docs: 文档更新
  • style: 代码格式调整（不影响功能）
  • refactor: 代码重构
  • test: 测试相关
  • chore: 构建过程或辅助工具变动

scope 可选值：

  • frontend: 前端相关
  • backend: 后端相关
  • docker: Docker 配置
  • deploy: 部署相关
  • ci: CI/CD 配置
  • docs: 文档

示例：

feat(backend): 添加服务器分组管理功能
fix(frontend): 修复工作流编辑器节点拖拽偏移问题
docs: 更新 API 文档中的认证接口说明
chore(docker): 优化 Dockerfile 减小镜像体积

开发流程 ​

  1. 选择 Issue：从 Issues 中选择一个你想处理的问题，或创建新的 Issue
  2. 评论认领：在 Issue 下评论表示你想处理，等待维护者分配
  3. 开发实现：按照上述规范进行开发
  4. 提交 PR：完成开发后提交 PR
  5. Code Review：等待维护者审查代码并根据反馈修改
  6. 合并：审查通过后由维护者合并到主分支

📧 联系方式 ​

如有任何问题，欢迎通过以下方式联系：

📄 许可证 ​

本项目采用 MPL-2.0 许可证。提交代码即表示你同意按照该许可证发布你的贡献。

再次感谢你的贡献！🎉

基于 MPL-2.0 许可证发布

Copyright © 2025-2026 谭策 | IT Online