框架

在閱讀了一般貢獻指南之後，以下是對框架倉庫貢獻的一些具體說明：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