Skip to content

Latest commit

 

History

History
173 lines (110 loc) · 4.51 KB

CONTRIBUTING-jyut.md

File metadata and controls

173 lines (110 loc) · 4.51 KB

貢獻指南

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

💻 設定開發環境

呢份專案係用咗 Vite 建立,請確保你已經單咗 Node.jspnpm,建議用 Visual Studio Code 進行開發。

🔧 開發同建置專案

開發(Chrome 或 Edge)

Chrome 或 Edge 嘅第一種方法

詳細內容
  1. 執行 pnpm 指令
# 安裝依賴
pnpm install

# 建立一個用家帳戶資料夾,用於延伸功能存儲登入狀態
mkdir web-ext-profile

# 運行專案
pnpm dev

# 打完呢條指令之後,會自動開啓一個新嘅 Chrome 視窗並且打開 BiliBili 網站
pnpm start:chromium
  1. 之後每次修改延伸功能,佢會重新載入,你可以 refresh 個網頁睇吓改變之後嘅效果

Chrome 或 Edge 嘅另外一種方法

詳細內容
  1. 執行 pnpm 指令
# 安裝依賴
pnpm install

# 運行專案
pnpm dev
  1. 喺 Chrome 入邊打開 chrome://extensions 頁面抑或喺 Edge 度打開 edge://extensions 頁面

  2. 打開開發者模式,撳載入解壓縮

Snipaste_2022-03-27_18-17-04
image
  1. 喺瀏覽器度載入產生嘅 extension/ 資料夾

每一次執過 code 之後,你都要撳 Extensions Reloader 粒掣,然之後 refresh 個 page,確保係有效果。

建置(Chrome 或 Edge)

建置延伸功能,要執行下底嘅指令

pnpm build

然之後打包 extension 下嘅檔案

開發(Firefox)

Firefox 嘅第一種方法

詳細內容
  1. 執行 pnpm 指令
# 安裝依賴
pnpm install

# 建立一個用家帳戶資料夾,用於延伸功能存儲登入狀態
mkdir web-ext-profile

# 運行專案
pnpm dev

# 打完呢條指令之後,會自動開啓一個新嘅 Firefox 視窗並且打開 BiliBili 網站
pnpm start:firefox
  1. 之後每次修改延伸功能,佢會重新載入,你可以 refresh 個網頁睇吓改變之後嘅效果

Firefox 嘅另外一種方法

詳細內容
  1. 執行 pnpm 指令
# 安裝依賴
pnpm install

# 運行專案
pnpm dev
  1. 喺瀏覽器度輸入 about:addons,撳 Extensions 然之後 Debug Add-ons
image
  1. 喺瀏覽器度載入產生嘅 extension-firefox/ 資料夾

建置(Firefox)

建置延伸功能,要執行下底嘅指令

pnpm build-firefox

然之後打包 extension-firefox 下嘅檔案

🤝 貢獻

關於分支

永久分支

  • Main:用呢個分支進行執 bug、新功能嘅開發、改進效能抑或執語系檔(i18n)。

其他臨時分支

  • feat/:提交新功能嘅分支
  • doc/:專門愛嚟執文檔,無功能變動嘅分支。
  • fix/:專門愛嚟執 dev 分支上嘅 bug。

Commit 慣例

你亦可以參考 Angular commit message guidelines

  • feat:新功能
  • fix:執 bugs
  • docs:文檔更新
  • style:唔影響代碼意思嘅變動(空白、格式、冇咗分號等)
  • refactor:代碼重構
  • test:新增或更新測試
  • chore:對建設過程或工具鏈進行更改
  • perf:效能改進
  • ci:持續集成/交付更改 歡迎添加範疇同腳註 例如: fix(dock):xxx 變更描述 相關 PR:url

i18n

  • 喺翻譯嗰陣,若然你遇到一種你唔熟嘅語言,你可以用第種識翻譯嘅語言來翻譯,兼且喺 PR 講明你唔識譯邊種語言。
  • 請手動維護 i18n 國際化語系檔!!! 請勿使用 i18n Ally 抑或其他擴充套件維護。 我知你可能唔係幾明,抑或可能唔鍾意咁樣,但係用 i18n Ally 進行維護之後,你唔之你翻譯咗嘅內容擺喺邊處,或剷咗程式碼註解。