跳到內容
開始使用

如何參與修改

先講結論:想改顏色、文字或手冊內容,不用自己寫程式。在 UIKit 的資料夾打開 Claude Code(在電腦上讓 Claude 幫你改檔案的工具),用平常說話的方式說要改什麼;看過預覽、你明確說可以之後,Claude 才會存下修改並送出「修改申請」(PR)。修改申請要由負責的角色核可,再由有合併權限的人合併。合併之後,目前不會自動更新任何網站:手冊和網站要部署到哪裡還沒有決定。

這一頁是摘要,寫給想知道「改一個東西要經過哪些人」的讀者。必須遵守的完整規則在 repository 的 docs/rules/ 資料夾(一次修改怎麼做:docs/rules/01-co-editing-sop.md;網站之間的差異和用詞:docs/rules/02-design-rules.md),電腦準備和本機預覽在 repository 的 CONTRIBUTING.md。這一頁和它們不一致時,以 docs/rules/ 為準。

角色核可什麼(已決定)核可什麼(暫定,待決定)
美編(設計)token 的名稱和值、命名規則、手冊的設計內容元件的視覺設計和外觀
工程建置、自動檢查(CI)、工具元件程式碼、相依套件、HeroUI 原始檔(heroui/)的修改
致遠(廠商)—用同一套流程參與修改;要不要核可、核可什麼,由專案負責人另訂
專案負責人—共編規則和整體規格的修改、路線圖的批次調整
Claude Code不核可,也不合併—
  • 「已決定」那一欄是專案負責人的決定。「暫定」那一欄是決定之前的做法:Claude 照它在修改申請寫出需要誰核可,但它還要專案負責人確認,不是最後的分工。
  • 每一個修改都經過修改申請(PR),由負責的角色核可,再由有合併權限的人合併。一個修改申請同時改到兩類內容時(例如 token 的值和建置的設定),兩個角色都要核可。
  • 今天核可只是大家的約定,系統還沒有強制;自動檢查(CI)也還沒有建立,Claude 在你電腦上跑的檢查就是合併前唯一的關卡。
  • 文件、修改申請和 repository 裡的任何檔案,人員只寫職稱,不寫姓名。唯一的例外在手冊裡:手冊用致遠這家廠商的公司名稱稱呼它,這是專案負責人的決定;手冊以外的檔案仍然寫「廠商」。
  1. 第 1 步: 說要改什麼

    你

    在 UIKit 的資料夾打開 Claude Code,用口語說要改什麼。Claude 先複述它的理解請你確認;是設計需求時,會問你這屬於第一級、第二級、第三級還是不適用(見下一節)。你不確定時,Claude 會說明理由並建議一級。

  2. 第 2 步: 開分支並修改

    Claude

    Claude 從共用主線(main)的最新內容另開一份修改用的複本(分支)來改;如果是修改既有的修改申請,就在它原本的分支上改。用到這個東西的地方一起更新。

  3. 第 3 步: 檢查並開預覽

    Claude

    Claude 在你的電腦上跑完檢查,打開本機預覽,告訴你要看哪幾頁、選哪個主題和色彩模式。不滿意就請它再改。

  4. 第 4 步: 確認後送出

    你和 Claude

    你明確說可以(例如「可以 commit」「好,開 PR」),Claude 才存下修改;推上分支前會再問你一次,再用你的 GitHub 帳號開修改申請,並寫出需要誰核可(電腦上沒有 GitHub CLI 時,Claude 會給你網址,請你在瀏覽器裡開)。

  5. 第 5 步: 核可與合併

    負責的角色

    負責的角色看過並核可,再由有合併權限的人合併。要修改時,作者在同一條分支上改,修改申請會自動更新。

「看起來不錯」不算確認;Claude 會再問一次。

網站之間的差異分三級

章節連結:網站之間的差異分三級

一個網站想和其他網站不一樣時,依序判斷,用最低的那一級解決。動手前,Claude 會照這個順序問你,並把答案和理由寫進修改申請。

級情況怎麼做
第一級只有外觀的數值不同:顏色、圓角、陰影、邊框、字級、間距用(或新增)一個主題
第二級內容一樣,結構或排列不同(例如圖片在上面還是在左邊)共用元件的一個變體,再由這個網站設定它的預設變體
第三級資料或功能不同,也就是別的網站沒有的東西新元件:通用的放進 UIKit;只屬於一個網站的,留在那個網站自己的專案
不適用所有網站一起改、文件、建置與工具照一般的規則修改預設值
  • 不可以為某個網站複製一份元件(例如另做一個只給某個網站用的按鈕)。
  • 某個網站不用某個元件時,什麼都不用做。
  • 主題的正式檔案和網站設定檔(各網站的預設變體)還沒有實作。需要它們時,Claude 會先停下來問工程,不自己發明做法。

Claude 會做什麼、不會做什麼

章節連結:Claude 會做什麼、不會做什麼

會做

  • 照你說的修改檔案,並一起更新用到它的地方。
  • 在你的電腦上跑檢查,打開本機預覽給你看。
  • 你明確確認後,存下修改、推上分支、開修改申請;推之前會再問你一次。

不會做

下面這些事,不論誰要求都不做。

  • 不核可,也不合併任何修改申請。
  • 不部署;不推、不直接改共用主線(main);不推 tag、不強制覆蓋(force push)。
  • 不為某個網站複製一份元件,不在檔案裡寫姓名、電子郵件或密碼。
  • 不改名或刪除 token 和用過的變體名稱,不自己安裝新的套件,不載入外部的字型、圖片或程式。

遇到分不清第幾級、需要新的 token 名稱、要改 HeroUI 原始檔或建置工具這類情況,Claude 會先停下來,告訴你該問誰。

核可=負責那一塊的角色看過修改申請,同意它可以合併。核可不等於合併:核可之後,還要由有合併權限的人合併。

每一份修改申請的說明都用白話寫這五段:

  1. 改了什麼
  2. 哪些畫面會變
  3. 請看哪幾頁:頁面路徑,以及要選的主題和色彩模式(淺色/深色)。
  4. 屬於哪一級:第一級、第二級、第三級或不適用,以及理由。
  5. 檢查結果

核可人不需要看懂程式碼。要看預覽時,在自己電腦的 UIKit 資料夾打開 Claude Code,說「幫我開修改申請 #編號 的預覽」,Claude 會開好預覽並告訴你要看哪幾頁。