框架

在阅读了通用贡献指南之后，这里是关于对 nuxt/nuxt 仓库贡献的一些特定点。

单仓库指南

• packages/kit: 用于编写 Nuxt 模块的工具包，发布为 @nuxt/kit。
• packages/nuxt: Nuxt 的核心，发布为 nuxt。
• packages/schema: 跨版本 Nuxt 类型定义和默认值，发布为 @nuxt/schema。
• packages/test-utils: Nuxt 的测试工具，发布为 @nuxt/test-utils。
• packages/vite: Vite 捆绑器用于 Nuxt，发布为 @nuxt/vite-builder。
• packages/webpack: webpack 捆绑器用于 Nuxt 3，发布为 @nuxt/webpack-builder。

设置

要为 Nuxt 做贡献，你需要设置一个本地环境。

1. Fork 到你的 GitHub 账户，然后 clone nuxt/nuxt 到你的本地设备。
2. 确保使用最新的 Node.js (20.x)
3. 启用 Corepack 以使用 pnpm 和 yarn
   Terminal

   corepack enable
   

4. 运行 pnpm install --frozen-lockfile 以使用 pnpm 安装依赖：
   Terminal

   pnpm install --frozen-lockfile
   

   如果你正在添加依赖，请使用 pnpm add。
   pnpm-lock.yaml 文件是所有 Nuxt 依赖的真相来源。
5. 激活被动开发系统
   Terminal

   pnpm dev:prepare
   

6. 检查一个分支，你可以在那里工作并提交你的更改：
   Terminal

   git checkout -b my-new-branch
   

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

游乐场

在工作拉取请求时，你可能会想要检查你的更改是否正确工作。

你可以修改 playground/ 中的示例应用，然后运行：

pnpm dev

测试

每个新功能都应该有相应的单元测试（如果可能的话）。这个仓库中的 test/ 目录目前是一个正在进行中的项目，但请尽量创建一个新的测试来遵循已有的示例。

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

pnpm test

代码格式化

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

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

pnpm lint

文档

如果你添加了一个新功能，重构或以任何其他方式改变了 Nuxt 的行为，你可能会想要记录这些更改。请在同一 PR 中包含文档更改。你不必在第一次提交时编写文档（但请尽早这么做）。

最终检查清单

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

文档指南

如果你注意到一个我们可以改进文档或错误消息的领域，请打开一个 PR，即使它只是一个拼写错误！

快速编辑

如果你发现了一个拼写错误或想要重述一句话，你可以在右侧的“社区”部分找到“编辑此页面”链接。

直接在 GitHub 界面中进行更改，然后打开一个 Pull Request。

较长的编辑

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

格式化文档

文档使用 MarkdownLint 和 case police 进行格式化，以保持文档的连贯性。

pnpm lint:docs

打开一个 PR

请确保你的 PR 标题遵循常规提交指南。

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