BewlyBewly/docs/CONTRIBUTING-cmn_TW.md

貢獻指南

English | 官话 - 简体中文 | 官話 - 繁体中文 | 廣東話

💻 設定開發環境

此專案使用 Vite 構建，請確保你離線安裝了 Node.js 和 pnpm，並推薦使用 Visual Studio Code 進行開發。

🔧 開發與建置專案

開發（Chrome 或 Edge）

Chrome 或 Edge 的第一種方法

詳細內容

1. 執行 pnpm 指令

# 安裝依賴
pnpm install

# 建立一個用戶的帳戶資料夾，用於擴充功能存儲登入狀態
mkdir web-ext-profile

# 運行專案
pnpm dev

# 打完這條指令之後，會自動開啓一個新的 Chrome 視窗並打開 BiliBili 網站
pnpm start:chromium

2. 之後每次修改擴充功能，他都會重新載入內容，你可以透過重新整理頁面來查看變更內容

Chrome 或 Edge 的另外一種方法

詳細內容

1. 執行 pnpm 指令

# 安裝依賴
pnpm install

# 運行專案
pnpm dev

2. 在地址欄輸入 chrome://extensions/（Chrome），edge://extensions/（Edge）並按 Enter 鍵

3. 啓用 開發者模式 並點擊 載入解壓縮

4. 在瀏覽器中載入生成的 extension/ 資料夾

每次修改後，您需要點選 Extensions Reloader 按鈕，然後重新整理頁面，以確保更改生效。

建置（Chrome 或 Edge）

建置此擴充功能，需要執行以下指令

pnpm build

然後打包 extension 下的檔案

開發（Firefox）

Firefox 的第一種方法

詳細內容

1. 執行 pnpm 命令

# 安裝依賴
pnpm install

# 建立一個用戶的帳戶資料夾，用於擴充功能存儲登入狀態
mkdir web-ext-profile

# 運行專案
pnpm dev

# 打完這條指令之後，會自動開啓一個新的 Firefox 視窗並打開 BiliBili 網站
pnpm start:firefox

2. 之後每次修改擴充功能，它都會重新加載，你可以透過重新整理頁面來查看變更內容

Firefox 的另一種方法

詳細內容

1. 執行 pnpm 命令

# 安裝依賴
pnpm install

# 運行專案
pnpm dev-firefox

2. 在瀏覽器中輸入 about:addons，點擊 Extensions 然後 Debug Add-ons

3. 然後在瀏覽器中使用 extension-firefox/ 資料夾載入此擴充功能。

構建（Firefox）

要構建擴展，運行

pnpm build-firefox

然後打包 extension-firefox 下的檔案

🤝 貢獻

關於分支

永久分支

• Main：用於錯誤修正開發新功能、性能改進或修改國際化（i18n）文件的分支。

其他臨時分支

• feat/：用於提交新功能的分支
• doc/：專門用於修正文檔，無功能更改的分支。
• fix/：專門用於修正 dev 分支中的錯誤的分支。

Commit 規範

你也可以參考 Angular commit message guidelines

• feat：新功能
• fix：錯誤修復
• docs：文檔更新
• style：不影響程式碼含義的更改（空白、格式、缺少分號等）
• refactor：重構程式碼
• test：添加或更新測試
• chore：對構建過程或工具鏈進行更改
• perf：效能改進
• ci：持續集成/交付更改 也歡迎添加範圍和腳註 例如： fix(dock)：xxx 變更描述 相關 PR：url

I18n

• 在進行翻譯時，如果你遇到一種你不熟悉的語言，你可以使用另一種你已經翻譯過的語言來翻譯，並在 PR 中指出你無法翻譯的那個語言。
• 請手動維護 i18n 國際化語系檔！！！ 請勿使用 i18n Ally 或其他擴充套件來進行維護。 我知道你可能會感到困惑，或者可能不喜歡這樣做，但使用 i18n Ally 進行維護後，將不確定翻譯放在哪裏，或刪除程式碼註解。