mirror of
https://gitee.com/dify_ai/dify.git
synced 2024-12-02 03:07:59 +08:00
155 lines
9.1 KiB
Markdown
155 lines
9.1 KiB
Markdown
所以你想为 Dify 做贡献 - 这太棒了，我们迫不及待地想看到你的贡献。作为一家人员和资金有限的初创公司，我们有着雄心勃勃的目标，希望设计出最直观的工作流程来构建和管理 LLM 应用程序。社区的任何帮助都是宝贵的。
|
||
|
||
考虑到我们的现状，我们需要灵活快速地交付，但我们也希望确保像你这样的贡献者在贡献过程中获得尽可能顺畅的体验。我们为此编写了这份贡献指南，旨在让你熟悉代码库和我们与贡献者的合作方式，以便你能快速进入有趣的部分。
|
||
|
||
这份指南，就像 Dify 本身一样，是一个不断改进的工作。如果有时它落后于实际项目，我们非常感谢你的理解，并欢迎提供任何反馈以供我们改进。
|
||
|
||
在许可方面，请花一分钟阅读我们简短的 [许可证和贡献者协议](./LICENSE)。社区还遵守 [行为准则](https://github.com/langgenius/.github/blob/main/CODE_OF_CONDUCT.md)。
|
||
|
||
## 在开始之前
|
||
|
||
[查找](https://github.com/langgenius/dify/issues?q=is:issue+is:open)现有问题，或 [创建](https://github.com/langgenius/dify/issues/new/choose) 一个新问题。我们将问题分为两类：
|
||
|
||
### 功能请求：
|
||
|
||
* 如果您要提出新的功能请求，请解释所提议的功能的目标，并尽可能提供详细的上下文。[@perzeusss](https://github.com/perzeuss) 制作了一个很好的 [功能请求助手](https://udify.app/chat/MK2kVSnw1gakVwMX)，可以帮助您起草需求。随时尝试一下。
|
||
|
||
* 如果您想从现有问题中选择一个，请在其下方留下评论表示您的意愿。
|
||
|
||
相关方向的团队成员将参与其中。如果一切顺利，他们将批准您开始编码。在此之前，请不要开始工作，以免我们提出更改导致您的工作付诸东流。
|
||
|
||
根据所提议的功能所属的领域不同，您可能需要与不同的团队成员交流。以下是我们团队成员目前正在从事的各个领域的概述：
|
||
|
||
| 团队成员 | 工作范围 |
|
||
| ------------------------------------------------------------ | ---------------------------------------------------- |
|
||
| [@yeuoly](https://github.com/Yeuoly) | 架构 Agents |
|
||
| [@jyong](https://github.com/JohnJyong) | RAG 流水线设计 |
|
||
| [@GarfieldDai](https://github.com/GarfieldDai) | 构建 workflow 编排 |
|
||
| [@iamjoel](https://github.com/iamjoel) & [@zxhlyh](https://github.com/zxhlyh) | 让我们的前端更易用 |
|
||
| [@guchenhe](https://github.com/guchenhe) & [@crazywoola](https://github.com/crazywoola) | 开发人员体验, 综合事项联系人 |
|
||
| [@takatost](https://github.com/takatost) | 产品整体方向和架构 |
|
||
|
||
事项优先级：
|
||
|
||
| 功能类型 | 优先级 |
|
||
| ------------------------------------------------------------ | --------------- |
|
||
| 被团队成员标记为高优先级的功能 | 高优先级 |
|
||
| 在 [community feedback board](https://github.com/langgenius/dify/discussions/categories/feedbacks) 内反馈的常见功能请求 | 中等优先级 |
|
||
| 非核心功能和小幅改进 | 低优先级 |
|
||
| 有价值但不紧急 | 未来功能 |
|
||
|
||
### 其他任何事情（例如 bug 报告、性能优化、拼写错误更正）：
|
||
* 立即开始编码。
|
||
|
||
事项优先级：
|
||
|
||
| Issue 类型 | 优先级 |
|
||
| ------------------------------------------------------------ | --------------- |
|
||
| 核心功能的 Bugs（例如无法登录、应用无法工作、安全漏洞） | 紧急 |
|
||
| 非紧急 bugs, 性能提升 | 中等优先级 |
|
||
| 小幅修复(错别字, 能正常工作但存在误导的 UI) | 低优先级 |
|
||
|
||
## 安装
|
||
|
||
以下是设置 Dify 进行开发的步骤：
|
||
|
||
### 1. Fork 该仓库
|
||
|
||
### 2. 克隆仓库
|
||
|
||
从终端克隆代码仓库：
|
||
|
||
```
|
||
git clone git@github.com:<github_username>/dify.git
|
||
```
|
||
|
||
### 3. 验证依赖项
|
||
|
||
Dify 依赖以下工具和库：
|
||
|
||
- [Docker](https://www.docker.com/)
|
||
- [Docker Compose](https://docs.docker.com/compose/install/)
|
||
- [Node.js v18.x (LTS)](http://nodejs.org)
|
||
- [npm](https://www.npmjs.com/) version 8.x.x or [Yarn](https://yarnpkg.com/)
|
||
- [Python](https://www.python.org/) version 3.10.x
|
||
|
||
### 4. 安装
|
||
|
||
Dify 由后端和前端组成。通过 `cd api/` 导航到后端目录，然后按照 [后端 README](api/README.md) 进行安装。在另一个终端中，通过 `cd web/` 导航到前端目录，然后按照 [前端 README](web/README.md) 进行安装。
|
||
|
||
查看 [安装常见问题解答](https://docs.dify.ai/v/zh-hans/learn-more/faq/install-faq) 以获取常见问题列表和故障排除步骤。
|
||
|
||
### 5. 在浏览器中访问 Dify
|
||
|
||
为了验证您的设置，打开浏览器并访问 [http://localhost:3000](http://localhost:3000)（默认或您自定义的 URL 和端口）。现在您应该看到 Dify 正在运行。
|
||
|
||
## 开发
|
||
|
||
如果您要添加模型提供程序，请参考 [此指南](https://github.com/langgenius/dify/blob/main/api/core/model_runtime/README.md)。
|
||
|
||
如果您要向 Agent 或 Workflow 添加工具提供程序，请参考 [此指南](./api/core/tools/README.md)。
|
||
|
||
为了帮助您快速了解您的贡献在哪个部分，以下是 Dify 后端和前端的简要注释大纲：
|
||
|
||
### 后端
|
||
|
||
Dify 的后端使用 Python 编写，使用 [Flask](https://flask.palletsprojects.com/en/3.0.x/) 框架。它使用 [SQLAlchemy](https://www.sqlalchemy.org/) 作为 ORM，使用 [Celery](https://docs.celeryq.dev/en/stable/getting-started/introduction.html) 作为任务队列。授权逻辑通过 Flask-login 进行处理。
|
||
|
||
```
|
||
[api/]
|
||
├── constants // 用于整个代码库的常量设置。
|
||
├── controllers // API 路由定义和请求处理逻辑。
|
||
├── core // 核心应用编排、模型集成和工具。
|
||
├── docker // Docker 和容器化相关配置。
|
||
├── events // 事件处理和处理。
|
||
├── extensions // 与第三方框架/平台的扩展。
|
||
├── fields // 用于序列化/封装的字段定义。
|
||
├── libs // 可重用的库和助手。
|
||
├── migrations // 数据库迁移脚本。
|
||
├── models // 数据库模型和架构定义。
|
||
├── services // 指定业务逻辑。
|
||
├── storage // 私钥存储。
|
||
├── tasks // 异步任务和后台作业的处理。
|
||
└── tests
|
||
```
|
||
|
||
### 前端
|
||
|
||
该网站使用基于 Typescript 的 [Next.js](https://nextjs.org/) 模板进行引导，并使用 [Tailwind CSS](https://tailwindcss.com/) 进行样式设计。[React-i18next](https://react.i18next.com/) 用于国际化。
|
||
|
||
```
|
||
[web/]
|
||
├── app // 布局、页面和组件
|
||
│ ├── (commonLayout) // 整个应用通用的布局
|
||
│ ├── (shareLayout) // 在特定会话中共享的布局
|
||
│ ├── activate // 激活页面
|
||
│ ├── components // 页面和布局共享的组件
|
||
│ ├── install // 安装页面
|
||
│ ├── signin // 登录页面
|
||
│ └── styles // 全局共享的样式
|
||
├── assets // 静态资源
|
||
├── bin // 构建步骤运行的脚本
|
||
├── config // 可调整的设置和选项
|
||
├── context // 应用中不同部分使用的共享上下文
|
||
├── dictionaries // 语言特定的翻译文件
|
||
├── docker // 容器配置
|
||
├── hooks // 可重用的钩子
|
||
├── i18n // 国际化配置
|
||
├── models // 描述数据模型和 API 响应的形状
|
||
├── public // 如 favicon 等元资源
|
||
├── service // 定义 API 操作的形状
|
||
├── test
|
||
├── types // 函数参数和返回值的描述
|
||
└── utils // 共享的实用函数
|
||
```
|
||
|
||
## 提交你的 PR
|
||
|
||
最后，是时候向我们的仓库提交一个拉取请求（PR）了。对于重要的功能，我们首先将它们合并到 `deploy/dev` 分支进行测试，然后再合并到 `main` 分支。如果你遇到合并冲突或者不知道如何提交拉取请求的问题，请查看 [GitHub 的拉取请求教程](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests)。
|
||
|
||
就是这样！一旦你的 PR 被合并，你将成为我们 [README](https://github.com/langgenius/dify/blob/main/README.md) 中的贡献者。
|
||
|
||
## 获取帮助
|
||
|
||
如果你在贡献过程中遇到困难或者有任何问题，可以通过相关的 GitHub 问题提出你的疑问，或者加入我们的 [Discord](https://discord.gg/8Tpq4AcN9c) 进行快速交流。
|