Files
BewlyBewly/docs/CONTRIBUTING-cmn_TW.md
Hakadao 19e8a20caa docs: add CONTRIBUTING.md (#586)
* docs(contributing): 更新贡献指南
相关issuse: https://github.com/hakadao/BewlyBewly/issues/164

* docs(CONTRIBUTING): Update contributing guidelines formatting and language

* feat: add icons to `NotificationsPop` &&  `MorePop` (#580)

* feat: `MorePop` item icon and cache `MomentPop`

* chore: revert cache MomentPop

* feat: `NotificationsPop` item icon

* chore(pkg): update deps

* style: Update icons in MorePop and NotificationsPop components

---------

Co-authored-by: starknt <1431880400@qq.com>

* docs: Update CONTRIBUTING.md && support other languages

* docs: update other languages link

* docs: update readme

---------

Co-authored-by: pengyunfei <pengyunfei@360.cn>
Co-authored-by: starknt <1431880400@qq.com>
2024-04-16 02:46:45 +08:00

3.4 KiB
Raw Blame History

貢獻指南

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

💻 設定開發環境

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

🔧 開發與建置專案

開發Chrome 或 Edge

  1. 執行 pnpm 指令
# 安裝依賴
pnpm install

# 運行專案
pnpm dev
  1. 在地址欄輸入 chrome://extensions/Chromeedge://extensions/Edge並按 Enter 鍵
  2. 啟用 開發者模式 並點擊 載入解壓縮
    Snipaste_2022-03-27_18-17-04
    image
  3. 在瀏覽器中載入生成的 extension/ 資料夾

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

建置Chrome 或 Edge

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

pnpm build

然後打包 extension 下的檔案

開發Firefox

  1. 執行 pnpm 命令
# 安裝依賴
pnpm install

# 運行專案
pnpm dev
  1. 在瀏覽器中輸入 about:addons,點擊 Extensions 然後 Debug Add-ons
    image
  2. 然後在瀏覽器中使用 extension-firefox/ 資料夾載入此擴充功能。

構建Firefox

要構建擴展,運行

pnpm build-firefox

然後打包 extension-firefox 下的檔案

🤝 貢獻

關於分支

永久分支

  • Main:主分支,代表穩定且可發布的版本,已發布版本的熱修復在此分支上開發。
  • Dev用於開發新功能、性能改進或修改國際化i18n文件的分支。

其他臨時分支

  • feat/:用於提交新功能的分支
  • doc/:專門用於修正文檔,無功能更改的分支。
  • bugfix/:專門用於修正 dev 分支中的錯誤的分支。
  • hotfix/:從 main 分支切出,用於修復線上問題的分支。

提交規範

  • feat:新功能
  • fix:錯誤修復
  • docs:文檔更新
  • style:樣式調整
  • refactor:重構程式碼
  • test:添加或更新測試
  • chore:對構建過程或工具鏈進行更改
  • perf:效能改進
  • ci:持續集成/交付更改 也歡迎添加範圍和腳註 例如: fix(dock)xxx 變更描述 相關 PRurl

I18n

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