框架

一旦您閱讀了一般貢獻指南，以下是關於向 nuxt/nuxt 儲存庫貢獻的一些具體要點。

Monorepo 指南

• packages/kit：用於撰寫 Nuxt 模組的工具包，發佈為 @nuxt/kit。
• packages/nuxt：Nuxt 的核心，發佈為 nuxt。
• packages/schema：跨版本的 Nuxt typedefs 和預設值，發佈為 @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 測試您的變更，並測試您的變更。

Playground

在處理提取請求時，您可能需要檢查您的變更是否正常運作。

您可以修改 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 標題符合 Conventional Commits 指南。

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