框架

在阅读了通用贡献指南之后，以下是关于向nuxt/nuxt仓库贡献的一些具体事项。

单体仓库指南

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

设置

要为Nuxt做出贡献，您需要设置本地环境。

1. Fork 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。
   pnpm-lock.yaml文件是所有Nuxt依赖的唯一真实来源。
5. 激活被动开发系统：
   终端

   pnpm dev:prepare
   

6. 签出一个分支以进行工作并提交更改：
   终端

   git checkout -b my-new-branch
   

然后，针对playground测试您的更改，并在提交拉取请求前测试您的更改。

Playground

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

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

pnpm dev

测试

每个新功能都应有对应的单元测试（如果可能）。此仓库中的test/目录目前仍在完善，但请尽量按照已有示例创建新测试。

在创建拉取请求或标记为可审阅之前，请确保通过运行以下命令使所有测试通过：

pnpm test

代码检查

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

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

pnpm lint

文档

如果您添加了新功能、进行了重构或以其他方式更改了Nuxt的行为，您可能需要记录这些更改。请在同一个拉取请求中包含对文档的更改。您不必在第一次提交时编写文档（但请在拉取请求足够成熟时尽快完成）。

最终检查清单

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

文档指南

如果您发现可以改进文档或错误信息的地方，请提交拉取请求——即使只是修复一个拼写错误！

快速编辑

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

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

较长编辑

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

文档检查

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

pnpm lint:docs

提交拉取请求

请确保您的拉取请求标题遵循常规提交指南。

docs: 更新有关nuxt.config.ts文件的章节