Skip to content

参与贡献

欢迎加入贡献者大家庭!

我们相信,每一份贡献都能让项目变得更好。无论你是编程新手还是资深开发者,你的参与都至关重要!贡献的多种打开方式(即使不写代码也能参与!)

贡献类型具体示例适合人群
代码贡献修复 bug、实现新功能、优化性能开发者
文档完善翻译文档、补充教程、撰写使用指南、更新 README写作爱好者、多语言使用者
问题反馈提交清晰的 bug 报告、提出功能需求、建议优化方向所有用户
社区支持回复讨论区问题、协助新人入门、组织线上分享会社区活跃者
资源分享提供测试用例、推荐技术方案、分享项目使用场景案例行业实践者

如何开始贡献?—— 三步轻松上手

找到你想解决的问题

  • 浏览现有 Issue:在项目 Issue 页中,找到感兴趣的Issue
  • 提出新需求:如果你发现Bug、问题或有新想法,点击New Issue按钮
    • Bug 报告规范:提交 Bug 报告时,需包含完整的环境信息(操作系统、浏览器版本、依赖库版本等)、详细的重现步骤以及错误日志,以便其他开发者快速复现和解决问题。
    • 新功能建议:提出新功能建议时,需阐述需求背景、预期效果以及大致的实现思路,方便团队评估功能的可行性和优先级。
markdown
### 问题描述(或功能建议)
[简要说明问题/需求]

### 重现步骤(如问题)
1. 执行命令`xxx`
2. 输入参数`xxx`
3. 预期结果:xxx
4. 实际结果:xxx

### 环境信息
- 系统版本:Windows 10 / macOS 13.2 / Ubuntu 22.04
- 软件版本:v1.2.3
- 其他依赖:xxx

### 建议方案(可选)
[如果有解决方案思路,可在此说明]

提交代码变更

代码提交规范

  • 提交代码时,遵循 “[模块名称] 简要描述:详细说明” 的提交信息格式,例如 “[用户模块] 优化登录逻辑:修复验证码验证失败问题”。
  • 代码需遵循项目指定的代码风格(若未指定,参考主流语言规范,如 Python 遵循 PEP8 规范),关键函数和复杂逻辑处必须添加注释,说明函数功能、参数含义和返回值等。
markdown
### 变更说明
[简要描述修改内容,例如:修复了Windows系统中路径分隔符错误]

### 解决的Issue
- 关联Issue #123

### 测试验证
[说明如何验证修改,例如:在Windows 10中执行安装脚本,未出现路径错误]

### 注意事项
[如有兼容性等特殊说明,可在此补充]

创建 Pull Request 的两种模式,参考资料

image-20250616094029577

等待反馈与合并

  • 维护者会在 24-72 小时内审核 PR,并给出修改建议。按建议调整后,PR 将被合并到主分支
  • 您的名字会出现在贡献者列表中

贡献规范与最佳实践

贡献规范

  • 代码规范:参考资料
  • 代码审查:PR 必须通过至少 1 位维护者审核,且测试覆盖率不低于 80%
  • 最佳实践:少量代码多提交,一次提交只解决一个问题

沟通礼仪

  • 在 Issue 和 PR 中使用友好语气,避免使用命令式表达
  • 讨论技术问题时,优先提供代码示例和错误日志

参考资料