框架

在阅读了一般贡献指南之后，以下是对框架仓库贡献的一些具体说明：nuxt/nuxt存储库。

Monorepo 指南

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

设置

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

1. 将仓库nuxt/nuxtfork 到您的 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/ 中的示例应用，并运行

pnpm dev

测试

每个新功能都应该有相应的单元测试（如果可能）。此仓库中的 test/ 目录目前正在开发中，但请尽力按照现有示例创建新测试。

在创建 PR 或将其标记为准备好审查之前，通过运行以下命令确保所有测试都通过：

pnpm test

代码检查

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

在提交更改之前，要验证代码样式是否正确，请运行

pnpm lint

文档

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

最终清单

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

文档指南

如果您发现我们可以改进文档或错误消息的区域，请务必提交 PR - 即使只是为了修复一个错别字！

快速编辑

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

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

较长的编辑

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

检查文档

文档使用MarkdownLint等等大小写检查以保持文档的连贯性。

pnpm lint:docs

打开 PR

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

docs: update the section about the nuxt.config.ts file