Skip to content

docs: 加入開源治理文件、README 主視覺與建置 CI - #1

Merged
kevinwatt merged 1 commit into
mainfrom
docs/opensource-readiness
Jul 8, 2026
Merged

docs: 加入開源治理文件、README 主視覺與建置 CI#1
kevinwatt merged 1 commit into
mainfrom
docs/opensource-readiness

Conversation

@kevinwatt

Copy link
Copy Markdown
Contributor

摘要

為對外開源,把先前於 staging workspace 準備好的文件與治理素材正式落地到本 repo,並補上建置 CI。

內容

治理文件(繁中為主、英文輔,含雙語切換)

  • CONTRIBUTING / SECURITY / CODE_OF_CONDUCT(各繁英兩版)+ NOTICE
  • 通報信箱:安全 security@biggo.vip、行為準則 code@biggo.vip

README

  • 換成繁中社群門面(README.md)+ 英文版(README.en.md)
  • 加入產品主視覺 hero 圖(docs/images/hero.png)
  • 舊開發者導向內容整理進 docs/DEVELOPMENT.md(建置變體/打包、環境變數、後端 host、sites.json 維護、專案結構)

基礎設施

  • .github/ issue / PR 模板
  • 新增建置 CI:.github/workflows/ci.yml — pnpm 9 + Node 20,matrix 建置 MV3 / MV2(Firefox)/ Safari 三變體

驗證

  • ✅ 本地實跑 CI 等效流程:pnpm install --frozen-lockfile + build / build:v2 / build:safari 三變體皆成功、產出 dist/manifest.json
  • ✅ 全文件雙語切換與交叉連結皆可解析
  • ✅ 無機密殘留(ga.js 已改吃 env、未設定時 no-op);建置產物未混入 commit

後續(非本 PR 範圍)

  • package.json:author 名稱與 LICENSE/NOTICE 的法人全名對齊、repository.url 格式(Phase 1,另處理)
  • Merge 前記得在 repo settings 啟用 DiscussionsSecurity Advisories(issue 模板 config.yml 有連過去,否則會 404)

為對外開源整理文件與基礎設施:

- 治理文件(繁中為主、英文輔,雙語切換):
  CONTRIBUTING / SECURITY / CODE_OF_CONDUCT + NOTICE
  (SECURITY 通報信箱 security@biggo.vip、行為準則 code@biggo.vip)
- README 換成繁中社群門面(+ README.en.md),加入產品主視覺 hero 圖
- 舊開發者 README 內容整理進 docs/DEVELOPMENT.md
  (建置變體/打包、環境變數、後端 host、sites.json 維護、專案結構)
- .github issue / PR 模板
- 新增建置 CI:.github/workflows/ci.yml
  以 pnpm 9 + Node 20 建置 MV3 / MV2 / Safari 三變體(已本地驗證通過)
@kevinwatt
kevinwatt merged commit 51f8734 into main Jul 8, 2026
3 checks passed
@kevinwatt
kevinwatt deleted the docs/opensource-readiness branch July 8, 2026 06:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant