Skip to main content

贡献指南

感谢您对 ai.net实验室的关注！我们欢迎所有形式的贡献。本指南将帮助您了解如何参与项目。

贡献方式​

代码贡献​

1. Fork 项目​

首先，Fork 您想要贡献的项目仓库到您的 GitHub 账户。

2. 克隆仓库​

git clone https://github.com/your-username/project-name.git
cd project-name

3. 创建分支​

git checkout -b feature/your-feature-name

4. 进行修改​

  • 编写代码
  • 添加测试
  • 更新文档

5. 提交更改​

git add .
git commit -m "feat: add your feature description"

请遵循 Conventional Commits 规范。

6. 推送并创建 Pull Request​

git push origin feature/your-feature-name

然后在 GitHub 上创建 Pull Request。

文档贡献​

文档贡献同样重要！您可以：

  • 修复文档中的错误
  • 添加新的文档内容
  • 翻译文档到其他语言
  • 改进文档的可读性

文档贡献的流程与代码贡献相同。

问题反馈​

如果您发现了 Bug 或有改进建议，请：

  1. 在 GitHub Issues 中搜索是否已有相关问题
  2. 如果没有，创建新的 Issue
  3. 提供详细的问题描述和复现步骤

社区讨论​

参与社区讨论也是重要的贡献方式：

  • 在 GitHub Discussions 中回答问题
  • 分享使用经验
  • 提出新的想法和建议

开发环境设置​

前置要求​

  • Node.js >= 18.0
  • npm >= 9.0
  • Git

安装依赖​

npm install

运行开发服务器​

npm start

运行测试​

npm test

代码规范​

代码风格​

  • 遵循项目的代码风格指南
  • 使用 ESLint 和 Prettier 格式化代码
  • 确保所有测试通过

提交信息规范​

我们使用 Conventional Commits 规范：

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

示例：

feat: add support for edge computing
fix: resolve memory leak in scheduler
docs: update installation guide

Pull Request 流程​

  1. 确保代码质量

    • 所有测试通过
    • 代码符合规范
    • 文档已更新

  2. 创建 Pull Request

    • 提供清晰的标题和描述
    • 说明更改的原因和影响
    • 关联相关的 Issue

  3. 代码审查

    • 维护者会审查您的代码
    • 根据反馈进行修改
    • 保持友好的沟通

  4. 合并

    • 审查通过后，维护者会合并您的 PR
    • 感谢您的贡献！

获取帮助​

如果您在贡献过程中遇到问题，可以通过以下方式获取帮助：

行为准则​

请确保您的行为符合我们的行为准则。

致谢​

感谢所有为 ai.net实验室做出贡献的开发者！您的贡献让这个项目变得更好。