Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 4.24 KB

CONTRIBUTING_CN.md

File metadata and controls

97 lines (63 loc) · 4.24 KB

贡献指南

非常感谢你考虑为 Dify 做出贡献!作为一家资源有限的创业公司,我们希望打造最直观的 LLM 应用开发和管理工作流程。社区的每一份贡献对我们来说都弥足珍贵。

我们需要保持敏捷和快速迭代,同时也希望确保贡献者能获得尽可能流畅的参与体验。这份贡献指南旨在帮助你熟悉代码库和我们的工作方式,让你可以尽快进入有趣的开发环节。

本指南和 Dify 一样在不断完善中。如果有任何滞后于项目实际情况的地方,恳请谅解,我们也欢迎任何改进建议。

关于许可证,请花一分钟阅读我们简短的许可和贡献者协议。社区同时也遵循行为准则

开始之前

想寻找可以着手的任务?浏览我们的新手友好议题并选择一个开始!

有酷炫的新模型运行时或工具要添加?在我们的插件仓库开启 PR,展示你的作品。

需要更新现有模型运行时、工具或修复 bug?前往我们的官方插件仓库大展身手!

加入我们,一起贡献,共同打造精彩项目!💡✨

请记得在 PR 描述中关联现有 issue 或创建新的 issue。

Bug 报告

Important

提交 bug 报告时请务必包含以下信息:

  • 清晰描述性的标题
  • 详细的 bug 描述,包括任何错误信息
  • 复现步骤
  • 预期行为
  • 日志,如果是后端问题,这点很重要,可以在 docker-compose 日志中找到
  • 截图或视频(如果适用)

优先级划分:

问题类型 优先级
核心功能 bug(云服务、登录失败、应用无法使用、安全漏洞) 紧急
非关键 bug、性能优化 中等优先级
小修复(拼写错误、界面混乱但可用) 低优先级

功能请求

Note

提交功能请求时请务必包含以下信息:

  • 清晰描述性的标题
  • 详细的功能描述
  • 功能使用场景
  • 其他相关上下文或截图

优先级划分:

功能类型 优先级
被团队成员标记为高优先级的功能 高优先级
来自社区反馈板的热门功能请求 中等优先级
非核心功能和小改进 低优先级
有价值但非紧急的功能 未来特性

提交 PR

项目设置

PR 提交流程

  1. Fork 本仓库
  2. 在提交 PR 之前,请先创建 issue 讨论你想要做的修改
  3. 为你的修改创建一个新的分支
  4. 请为你的修改添加相应的测试
  5. 确保你的代码能通过现有的测试
  6. 请在 PR 描述中关联相关 issue,格式为 fixes #<issue编号>
  7. 等待合并!

前端

关于前端服务的设置,请参考 web/README.md 文件中的详细指南。该文档提供了帮助你正确配置前端环境的详细说明。

后端

关于后端服务的设置,请参考 api/README.md 文件中的详细说明。该文档包含了帮助你顺利运行后端的步骤说明。

其他注意事项

我们建议在开始设置之前仔细阅读本文档,因为它包含以下重要信息:

  • 前置条件和依赖项
  • 安装步骤
  • 配置细节
  • 常见问题解决方案

如果在设置过程中遇到任何问题,请随时联系我们。

获取帮助

如果你在贡献过程中遇到困难或有紧急问题,可以通过相关 GitHub issue 向我们提问,或加入我们的 Discord 进行快速交流。