跳到主要内容

贡献 Langflow

本指南旨在帮助您开始为 Langflow 做出贡献。作为一个在快速发展领域的开源项目，Langflow 欢迎各种形式的贡献，无论是新功能、改进的基础设施还是更好的文档。

要向本项目贡献代码或文档，请遵循fork 和 pull request工作流程。

贡献代码​

使用 uv 和 Node.js 在本地开发 Langflow。

先决条件​

克隆 Langflow 仓库​

  1. 导航到 Langflow GitHub 仓库，然后点击 Fork。

  2. 将新的远程仓库添加到本地机器上的本地仓库


_10
git remote add fork https://github.com/<your_git_username>/langflow.git

准备开发环境​

  1. 创建开发钩子。

_10
make init

此命令通过安装后端和前端依赖项、构建前端静态文件并初始化项目来设置开发环境。它运行 make install_backend、make install_frontend、make build_frontend，最后运行 uv run langflow run 来启动应用程序。

  1. 在推送到仓库之前运行 make lint、make format 和 make unit_tests。

调试​

仓库包含一个用于在 VSCode 中调试后端的 .vscode/launch.json 文件，这比使用 Docker Compose 调试更快。要使用 VSCode 中的 launch.json 文件调试 Langflow

  1. 在 VSCode 中打开 Langflow。
  2. 按下 Windows 上的 Ctrl+Shift+D 或 Mac 上的 Cmd+Shift+D 打开运行和调试视图。
  3. 从运行和调试下拉列表中选择一个调试配置。
  4. 单击绿色的播放按钮或按 F5 开始调试。

使用 launch.json 可以直接从 VSCode 快速调试应用程序的不同部分，如后端、前端或 CLI。

在本地运行 Langflow​

使用 make init 设置环境后，您可以分开运行 Langflow 的后端和前端进行开发。Langflow 建议使用 venv 或 conda 等虚拟环境来隔离依赖项。

开始之前，请确保已安装 uv 和 Node.js。

  1. 在仓库根目录中，安装依赖项并启动后端的开发服务器

_10
make backend

  1. 安装依赖项并启动前端

_10
make frontend

这种方法允许您独立处理后端和前端，并通过热重载加快开发速度。

贡献文档​

文档是使用 Docusaurus 构建的，并以 Markdown 编写。

先决条件​

克隆 Langflow 仓库​

  1. 导航到 Langflow GitHub 仓库，然后点击 Fork。

  2. 将新的远程仓库添加到本地机器上的本地仓库


_10
git remote add fork https://github.com/<your_git_username>/langflow.git

  1. 要在本地运行文档，请运行以下命令

_10
cd docs
_10
yarn install
_10
yarn start

文档将在 localhost:3000 上可用，所有文件都位于 docs/docs 文件夹中。

打开 Pull Request​

完成代码编写，并使用 make lint 和 make unit_tests 手动测试您的更改后，打开一个 pull request 将您的更改发送到主 Langflow 仓库的上游。

  1. 打开一个新的 GitHub pull request，将您的补丁提交到 main 分支。
  2. 确保 PR 标题遵循语义提交约定。例如，新功能是 feat: add new feature，修复是 fix: correct issue with X。
  3. Langflow 维护者将审核您的 pull request。感谢您的贡献！

关于 pull request 标题的一些补充指导

  • 确保 pull request 描述清晰地说明了问题和解决方案。如果 PR 修复了一个问题，请在 PR 描述中包含指向已修复问题的链接，使用 Fixes #1234。
  • pull request 标题将出现在 Langflow 的发布说明中，因此它们应该尽可能明确地解释 PR 所做的工作。
  • pull request 应力求只修复一件事情，并且应包含对所修复内容的详细描述。

更多信息，请参阅Python 开发者指南。

Search