跳到主要内容

框架贡献

关于向框架仓库贡献的一些具体要点。

阅读完通用贡献指南后,这里是关于向 nuxt/nuxt 仓库贡献的一些具体要点。

Monorepo 指南

环境搭建

要贡献 Nuxt,你需要搭建一个本地环境。

  1. Fork nuxt/nuxt 仓库到你自己的 GitHub 账户,然后克隆到你的本地设备。
  2. 确保使用最新的 Node.js
  3. 启用 Corepack 以获得 pnpmyarn
    Terminal
    corepack enable
    
  4. 运行 pnpm install --frozen-lockfile 用 pnpm 安装依赖:
    Terminal
    pnpm install --frozen-lockfile
    
    如果你要添加依赖,请使用 pnpm add。:br pnpm-lock.yaml 文件是所有 Nuxt 依赖的权威来源。
  5. 激活被动开发系统
    Terminal
    pnpm dev:prepare
    
  6. 检出一个你可以工作并提交更改的分支:
    Terminal
    git checkout -b my-new-branch
    

然后,在提交 Pull Request 之前,针对 playground 测试你的更改并测试你的更改。

Playground

在处理 Pull Request 时,你很可能想检查你的更改是否正确。

你可以修改 playground/ 中的示例应用,并运行:

Terminal
pnpm dev

请确保不要将其提交到你的分支,但在 PR 描述中添加一些示例代码可能会有帮助。这可以帮助审查者和其他 Nuxt 用户深入理解你构建的功能。 ::

测试

每个新功能都应有一个对应的单元测试(如果可能)。本仓库中的 test/ 目录目前仍在进行中,但请尽力参照已有示例创建一个新的测试。

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

Terminal
pnpm test

Lint

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

在提交更改之前,要验证代码风格是否正确,运行:

Terminal
pnpm lint
你可以使用 pnpm lint --fix 修复大部分风格更改。:br 如果仍有错误遗留,你必须手动纠正它们。 ::

文档

如果你正在添加新功能、重构或以任何其他方式改变 Nuxt 的行为,你可能想要记录这些更改。请将任何文档更改包含在同一 PR 中。你不必在第一次提交时就写好文档(但请在你的 Pull Request 足够成熟时尽快这样做)。

请确保根据文档风格指南进行更改。 ::

最终检查清单

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

文档指南

如果你发现我们可以改进文档或错误消息的地方,请打开 PR——即使只是修复一个错别字!

请确保根据文档风格指南进行更改。 ::

快速编辑

如果你发现一个错别字或想改写一个句子,可以点击位于右侧边栏 Community 板块中的 Edit this page 链接。

直接在 GitHub 界面中进行更改并开启一个 Pull Request。

较长的编辑

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

要在本地预览文档,请遵循 nuxt/nuxt.com 仓库中的步骤。 ::
我们推荐你为 VS Code 安装 MDC 扩展。 ::

Lint 文档

文档使用 MarkdownLintcase police 进行 lint,以保持文档的一致性。
Terminal
pnpm lint:docs
你也可以运行 pnpm lint:docs:fix 来突出并解决任何 lint 问题。 ::

开启一个 PR

请确保你的 PR 标题遵循约定式提交指南。
Example of PR title
docs: update the section about the nuxt.config.ts file