框架贡献

在阅读了 一般贡献指南 后，以下是关于对 nuxt/nuxt 仓库贡献的一些具体要点。

Monorepo 指南

• packages/kit：用于编写 Nuxt 模块的工具包，以 @nuxt/kit 发布。
• packages/nuxt：Nuxt 的核心，以 nuxt 发布。
• packages/schema：跨版本的 Nuxt 类型定义和默认值，以 @nuxt/schema 发布。
• packages/rspack：用于 Nuxt 的 Rwebpack 打包器，以 @nuxt/rspack-builder 发布。
• packages/vite：用于 Nuxt 的 Vite 打包器，以 @nuxt/vite-builder 发布。
• packages/webpack：用于 Nuxt 的 webpack 打包器，以 @nuxt/webpack-builder 发布。

设置

要贡献给 Nuxt，您需要设置一个本地环境。

1. 分叉 nuxt/nuxt 仓库到您自己的 GitHub 账户，然后 克隆 到您的本地设备。
2. 确保使用最新的 Node.js (20.x)。
3. 启用 Corepack 以获取 pnpm 和 yarn
   终端

   corepack enable
   

4. 运行 pnpm install --frozen-lockfile 来使用 pnpm 安装依赖项：
   终端

   pnpm install --frozen-lockfile
   

   如果您添加了一个依赖项，请使用 pnpm add。:br pnpm-lock.yaml 文件是所有 Nuxt 依赖项的真实来源。
5. 激活被动开发系统
   终端

   pnpm dev:prepare
   

6. 检出一个可以工作并提交更改的分支：
   终端

   git checkout -b my-new-branch
   

然后，在提交拉取请求之前，请测试您的更改与 游乐场 和 测试。

游乐场

在处理拉取请求时，您可能希望检查您的更改是否正常工作。

您可以修改 playground/ 中的示例应用，并运行：

pnpm dev

测试

每个新功能都应该有相应的单元测试（如果可能的话）。该仓库中的 test/ 目录目前正在进行中，但请尽力创建一个新的测试，参照已有的例子。

在创建 PR 或标记为准备审核之前，确保所有测试都通过，运行：

pnpm test

代码检查

您可能已经注意到，我们使用 ESLint 来强制执行编码标准。

在提交更改之前，为了验证代码风格是否正确，运行：

pnpm lint

文档

如果您正在添加新功能，或以其他方式重构或更改 Nuxt 的行为，您可能希望记录这些更改。请在同一个 PR 中包含对文档的任何更改。您不必在第一次提交时就写好文档（但请在您的拉取请求成熟后尽快补充）。

最终清单

提交 PR 时，您需要填写一个简单的模板。请在检查清单中勾选所有适当的“答案”。

文档指南

如果您发现可以改进文档或错误消息的地方，请打开 PR - 即使只是修复一个拼写错误！

快速编辑

如果您发现拼写错误或想要重新表述一个句子，可以点击位于 社区 部分右侧的 编辑此页面 链接。

直接在 GitHub 界面中进行更改并打开拉取请求。

长期编辑

文档内容位于 nuxt/nuxt 仓库的 docs/ 目录中，并使用 markdown 编写。

文档代码检查

文档使用 MarkdownLint 和 case police 进行代码检查，以保持文档的一致性。

pnpm lint:docs

打开 PR

请确保您的 PR 标题遵循 约定式提交 指南。

docs: 更新有关 nuxt.config.ts 文件的部分