參與

從最小的一步開始

最常見的誤解是「要寫一篇完整的技能才叫貢獻」。不是的。 這裡有四個階梯,第一階完全不需要碰 Git,五分鐘就能做完。

階梯

挑一個你現在做得到的

① 五分鐘 · 免 Git

用講的投稿

把你的實務經驗用自己的話寫下來 —— 一段也好。格式、分類、frontmatter 全部交給維護者整理。 這是最歡迎、也最缺的一種貢獻,因為經驗只有你有,格式誰都能補

開一則知識投稿
② 十分鐘 · 需要 GitHub 帳號

回報或修正一個錯誤

發現法規條號過期、數字有誤、連結壞掉、錯字 —— 直接在 GitHub 上點編輯改掉送出, 或開一則 issue 講一聲。指出錯誤和寫新內容一樣有價值, 尤其在一個會被拿去當判斷依據的庫裡。

回報問題
③ 半小時 · 有明確清單

補一個缺掉的欄位

知識庫裡有一批技能缺適用地區、適用對象、授權與相容性標示。 這些任務範圍明確、不需要從零寫起,很適合當第一次送 PR 的練習。 需要補什麼,狀況頁上一筆一筆列著。

看最需要補的清單
④ 一個下午 · 完整貢獻

寫一個技能模組

你最熟的那個題目 —— 送審流程、某條法規的實務陷阱、某個標章的計算眉角。 複製 知識樣板/ 當起點,寫 domain.md(人讀)加 SKILL.md(AI 讀)。建議用 AI 輔助整理格式。

讀貢獻指南

送 PR 前,先過這幾關

完整規則在 CONTRIBUTING.md, 這裡是最常踩到的幾條。

命名:上層中文,最底層英文

分類與知識入口用繁體中文,AI 技能資料夾一律小寫英文加連字號,而且必須是英文翻譯,不能用拼音

✅ 建築法規/消防安全/排煙窗法規檢討/domain.md
✅ 建築法規/消防安全/排煙窗法規檢討/smoke-exhaust-review/SKILL.md
❌ .../pai-yan-chuang/SKILL.md  ← 拼音不收

frontmatter:name 必須等於資料夾名稱

SKILL.mdname 要跟它所在的英文資料夾完全一致, description 要寫出具體的觸發情境,AI 才知道什麼時候該叫用它。 建立新知識時,直接複製 知識樣板/ 當起點最不容易出錯。

保密邊界(這條最重要)

不要上傳任何未經授權的業主資料、案件圖說、契約、報價或個資。 這個庫收的是產業的公共判準,不是你的案子。 如果一段內容只有你的客戶適用,那它不屬於這裡; 把它抽象成通則之後再寫進來。

正確性優先於數量

引用法規請附條號與來源,不確定的地方請明白標示不確定 —— 這個庫寧可少收一篇,也不要收一篇看起來很篤定卻沒有依據的內容。 詳見品質與免責


你的貢獻會怎麼被處理

  1. 開 issue 或送 PR —— 兩種都可以,用講的也行
  2. 維護者審閱 —— 檢查格式、命名、保密邊界與內容合理性
  3. 自動驗證 —— scripts/validate_okf.py 檢查 OKF 格式是否完整
  4. 合併並署名 —— 你的 GitHub 帳號會出現在貢獻者名單與更新紀錄裡

貢獻即表示你同意內容以 CC BY-SA 4.0(文字)與 Apache 2.0(程式碼)授權釋出, 並確認你有權釋出這些內容。

不確定自己的經驗算不算數?

算。你覺得「這不是大家都知道嗎」的那件事,通常正是新人卡最久的那一關。

用講的投稿,五分鐘 或先來小聚聊聊