贡献者设置

要求

• Git (必需)
• Node.js v24.16.0 (必需)
• npm v11.16.0 (必需)
• MongoDB (必需，用于数据库)
• Git LFS（适用于较大文件）
• GitHub Desktop（可选）
• VSCode（推荐的源代码编辑器）

推荐的 VSCode 扩展

在 VS Code 中安装这些扩展：

• Prettier
• ESLint
• GitLens

准备环境

Node.js 和 npm

如果您使用 nvm，请在安装 LibreChat 之前安装并选择推荐的 Node.js 版本：

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]

验证您的 shell 是否正在使用预期的版本：

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Fork LibreChat 仓库：https://github.com/danny-avila/LibreChat/fork

• 在你的 fork 上创建一个分支，为其命名，并将其关联到原始仓库。

• 将您的新分支下载到本地电脑

git clone -b branch-name https://github.com/username/LibreChat.git

将 branch-name 和 username 替换为您的详细信息

在 VS Code 中打开

• 克隆您的分支后：

  cd LibreChat

  code .

准备 LibreChat

• 在 VS Code 中使用 ctrl+shift+` 打开终端。

  或者，使用 ctrl+j 打开底部面板并选择终端。

• npm run smart-reinstall

  如果您刚刚更改了 Node.js 或 npm 版本，请使用 npm run reinstall 执行一次干净的安装。

• npm run build

• .env 配置

  • 创建 .env 文件。如果你还没有该文件，请复制 .env.example 并进行配置。

开发工作流程

为了在 LibreChat 上高效工作，请使用以下命令：

• 启动后端：

  • 使用 npm run backend 进行正常操作。
  • 对于活跃开发，请使用 npm run backend:dev 来监控更改。
  • 通过 http://localhost:3080/ 进行访问。

• 在开发模式下运行前端：

  • 确保后端正在运行。
  • 使用 npm run frontend:dev 来监控前端更改。
  • 在 http://localhost:3090/ 查看。

本地测试

在提交之前，请在本地测试您的更新，请参阅：Perform Tests Locally

通过运行测试，确保您的贡献稳健且已准备好进行集成。

提交 (Commit)、推送 (Push)、拉取请求 (Pull Request, PR)

提交更改

Commits 标记了开发过程中的逻辑检查点。请包含清晰的说明信息来解释所做的更改。

示例：

git add .
git commit -m "Add login functionality"

推送更改

在完成功能或修复问题后，将更改 Push 到远程仓库。

示例：

git push origin feature-branch-name

创建 Pull Request (PR)

Pull Request 将更改从功能分支合并到主分支。

1. 从 main 分支拉取最新更改并解决冲突。
2. 推送更新后的功能分支。
3. 确保代码遵循项目指南。

示例：

git checkout main
git pull origin main
git checkout feature-branch-name
git rebase main
# Resolve conflicts if any
git push origin feature-branch-name
# Open PR on GitHub

在浏览器中访问您的仓库并点击“Contribute”。

安全地回滚提交 (Revert Commits)

若要撤销功能分支中的更改，请谨慎执行以下步骤：

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  将 pick 替换为 drop 以移除提交。保存并退出编辑器。

• git push --force-with-lease origin feature-branch-name