---
title: "贡献指南"
locale: "zh"
version: "1.x"
canonicalUrl: "https://farmfe.org/zh/docs/1.x/contribution"
publicationStatus: "prerelease"
---

<a id="贡献指南"></a>
# 贡献指南


非常感谢您对 Farm 的贡献, 在您提交 Pull Request 之前, 请先阅读以下指南。


<a id="行为规范准则"></a>
## 行为规范准则


所有贡献者都应该遵循 Rust [行为规范](<https://www.rust-lang.org/policies/code-of-conduct>)。


<a id="错误报告"></a>
## 错误报告


目前 Farm 正在快速开发和迭代中, 正在积极开发 2.0 版本我们会增加许多新功能以及加大生态兼容性以及各种目前问题的优化与更新 在开发和使用中可能会遇到一些问题, 如果您遇到了一些我们不可预料的问题, 请提交 issues 用来报告错误问题, 通过新建一个 [issues](<https://github.com/farm-fe/farm/issues/new/choose>) 来报告您所遇到的问题。


<a id="创建新特性"></a>
## 创建新特性


如果要创建新的功能或者特性, 请在 issues 中添加 [feature request](<https://github.com/farm-fe/farm/issues/new/choose>)。


<a id="提交代码指南"></a>
## 提交代码指南


- 编写代码的时候, 请遵循代码编写规范。
- 设置您的本地开发环境。
- 在您的本地从 ` main ` 分支切出一个新的功能特性分支。
- 使用 ` cargo test ` 确保所有测试均能通过。
- 如果您已经更改了一些包并准备更新版本，则您应该在根目录中输出` npx changeset ` 用来发布新版本并且提交。 我们应该尽量保持发布 ` patch ` 版本, 如果没有重大更改的情况下，请选择 更新 ` patch ` 版本
- 当你完成你的工作后，请通过 ` pnpm run ready ` 来验证是否可以在本地正常运行


<a id="设置"></a>
## 设置


- Fock 并且 clone 仓库到本地。
- 为你的 PR 创建一个新的分支。 ` git checkout -b your-branch-name `。
- 保证您的 ` main ` 分支指向远程仓库, 并从分支上发出拉取请求, 请确保您的分支是基于 ` main ` 分支的, 并且运行:
- 添加了 Farm 的 upstream 远程仓库


```bash
  git remote add upstream https://github.com/farm-fe/farm.git
```


- 从 upstream 远程仓库获取所有分支和它们的提交


```bash
  git fetch upstream
```


- 建立了你本地 main 分支与 upstream 仓库 main 分支之间的跟踪关系


```bash
  git branch --set-upstream-to=upstream/main main
```


<a id="设置您的本地开发环境"></a>
## 设置您的本地开发环境


<a id="依赖"></a>
### 依赖


![](<https://github.com/user-attachments/assets/f7ce7d67-542b-41c8-a432-205c9a01c33b>)
- 安装 Rust 环境 [rustup](<https://www.rust-lang.org/tools/install>)。
- 确保您的 [Node.js](<https://nodejs.org>) 版本在 **16** 以上。
- 确保您的 [Pnpm](<https://pnpm.io>) 版本在 **8** 以上。


<a id="ide"></a>
### IDE


我们推荐使用 ` vscode ` 进行开发, 并且我们推荐两个必要的插件


- ` rust-analyzer ` 支持 ` rust ` 语言。
- ` biome ` 使用 ` biome ` 进行格式化和检查代码。


你可以在扩展中安装它们


<a id="其他依赖"></a>
### 其他依赖


<a id="运行项目"></a>
## 运行项目


Farm 的开发启动非常简单, 您只需在根目录中执行 ` pnpm bootstrap ` 一条命令即可构建所有子包中需要构建的代码。


```bash
$ pnpm bootstrap # install the dependencies of the project with series of initialization operations.
```


- 使用` pnpm bootstrap `安装依赖项，并通过一系列初始化操作构建核心包。
- 使用示例(打开新终端)：` cd examples/react && pnpm start `，如果示例不能正常启动，则上报问题。
- 如果` examples/react `正常运行，则表明开发环境配置成功。
- 如果您更改了` crates `中的 ` Rust ` 代码，请再次运行 ` Packages/core ` 下的 ` npm run build：rs ` 以获取最新的二进制代码。


当你在开发 node 侧代码时, 根目录执行 pnpm start 就可以实时调试代码了，当你在开发 rust 侧代码时， 根目录执行 pnpm start:rs 就可以实时调试代码了


```bash
// node side
pnpm start

// rust side
pnpm start:rs
```


<a id="测试"></a>
## 测试


我们还需要测试两个部分，一套 ` Rust ` 测试，一套 ` Node ` 测试，在您提交代码之前，请确保所有测试均能通过。


<a id="rust-测试"></a>
### Rust 测试


- 在根目录下输入 ` cargo test ` 将会运行所有的 ` Rust ` 代码测试用例。


```sh
# root path or crates path
cargo test
```


<a id="node-测试"></a>
### Node 测试


- 在根目录下输入 ` pnpm test ` 基于 ` vitest ` 运行所有的 ` Node ` 代码测试用例。


```sh
# root path
pnpm test
```


<a id="通过脚手架快速创建插件"></a>
## 通过脚手架快速创建插件


Farm 提供了一个脚手架来帮助您快速创建一个插件, 您可以通过以下命令来创建一个插件。
您可以 ` cd packages/cli ` 目录下, 运行 ` npm link ` 或者全局安装 ` @farmfe/cli ` 来使用,
安装完成之后, 您可以通过 ` farm plugin create ` 来创建一个插件, 支持 ` rust ` 和 ` js ` 插件


```bash
$ farm plugin create <plugin-name> # create a plugin support js or rust
```


<a id="小提示"></a>
## 小提示


Farm 整个项目分为两个部分, JavaScript 和 Rust。


- **JavaScript** 部分: 查看 packages 文件夹中的代码, 包含核心包(开发服务, 文件监听, 编译器包装), 脚手架, 运行时和运行时插件 (模块系统, HMR 热更新)。
- **Rust** 部分: 查看 crates 以及 rust-plugin 文件夹中的代码, 包含核心包 (编译上下文, 插件驱动等), 编译器 (编译进程、HMR 更新等), Rust 插件。