Nuxt3 中文课程《实战全栈开发简书》限时优惠

框架

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

在阅读了一般贡献指南之后,下面是关于对nuxt/nuxt仓库的贡献的一些具体要点。

Monorepo指南

设置

要为Nuxt做贡献,你需要设置本地环境。

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

然后,在提交拉取请求之前,请在playground中测试你的更改并进行测试

Playground

在处理拉取请求时,你可能会想要检查你的更改是否正常工作。

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

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

测试

每个新功能都应该有相应的单元测试(如果可能)。这个仓库中的test/目录目前还在进行中,但请尽力创建一个新的测试,按照已经存在的示例进行。

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

终端
pnpm test

代码风格检查

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

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

终端
pnpm lint
你可以使用pnpm lint --fix来修复大部分的样式更改。
如果仍然有错误,请手动更正。

文档

如果你正在添加新功能,重构或以其他方式更改Nuxt的行为,你可能想要记录这些更改。请在同一个PR中包含对文档的任何更改。你不必在第一次提交时编写文档(但是请在你的拉取请求足够成熟时尽快编写)。

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

最终检查表

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

文档指南

如果你发现可以改进文档或错误消息的地方,请打开PR,即使只是为了修复一个拼写错误!

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

快速编辑

如果你发现了一个拼写错误或想要重新表达一个句子,你可以点击编辑此页面链接,该链接位于Community部分的右侧。

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

较长的编辑

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

要在本地预览文档,请按照nuxt/nuxt.com仓库上的步骤进行操作。
我们建议你安装VS Code的MDC扩展

检查文档风格

文档使用MarkdownLintcase police进行校验,以保持文档的一致性。

终端
pnpm lint:docs
你也可以运行pnpm lint:docs:fix来突出显示和解决任何校验问题。

打开一个PR

请确保你的PR标题符合约定性提交的准则。

PR标题示例
docs: 更新关于nuxt.config.ts文件的部分