框架

阅读完通用贡献指南后，以下是一些关于对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：Nuxt 的Vite打包器，发布为@nuxt/vite-builder。
• packages/webpack：Nuxt 3 的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/中的示例应用程序，并运行

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: update the section about the nuxt.config.ts file