docs(tools): 補上腳本結束碼說明,並改指階梯規則正本

腳本標頭沒把每個結束碼代表什麼、該怎麼處理寫清楚,呼叫端只能用猜的。階梯表又同時抄在說明檔與技能內文,改規則時兩邊容易不同步。

- 推導基底的腳本標頭逐碼說明狀況與處置,並標明該碼屬於哪一種模式。
- 產生分支名的腳本標頭補上參數不足的結束碼。
- 說明檔刪掉重複的階梯表,改指向指引的階梯章節。
- 說明檔補上型別優先序腳本的說明,並更新兩支技能的摘要。
This commit is contained in:
2026-08-31 11:05:49 +08:00
parent fcd0b3b8c0
commit 25792fd279
3 changed files with 28 additions and 18 deletions
+17 -6
View File
@@ -22,12 +22,23 @@
# 分支名只允許 ASCII(a-z0-9 與 /、-)。中文簡述先交給同目錄的 slugify.sh 轉成 ASCII slug,
# 再組成分支名,這支腳本不接受非 ASCII 分支名。
#
# 輸出: 選中的分支名(一行)。
# 護欄: 參數過多回傳 2;抓不到遠端回傳 3;呼叫方指定的分支不在遠端回傳 4;
# develop、main、master 都不在遠端回傳 5;傳入空字串回傳 6;
# 推不出唯一合法基底回傳 7;推導出的基底不在遠端又不能自動建立回傳 8;
# 自動建立功能主幹失敗回傳 9。
# 錯誤訊息一律印繁中到 stderr。
# 輸出: 選中的分支名(一行)。錯誤訊息一律印繁中到 stderr。
# 結束碼: 0=stdout 印出一個基底分支名,兩種模式共用。直接拿它開 PR。
# 2=參數過多(兩種模式共用)。分支名要用引號包成單一參數,再重跑。
# 3=連不上 origin,git fetch 失敗(兩種模式共用)。先確認遠端可以連線,再重跑。
# 4=(呼叫方模式)呼叫方指定的分支不在 origin 上。停下來問使用者原本要的是哪一條,
# 不要自行改用其他分支。
# 5=(呼叫方模式)origin 上找不到 develop、main、master。這個碼只在完全沒傳參數時
# 才會出現,所以真正的問題通常是基底參數在路上掉了。請由呼叫方指定基底分支。
# 6=(呼叫方模式)傳進來的是空字串。回去補上分支變數的值,不要改成整個參數不傳——
# 不傳會悄悄退回 develop。
# 7=(--derive 模式)推不出唯一合法基底:站在斷頭狀態、站在 master、分支名含非 ASCII
# 或其他不允許的字元、類型不在階梯表內、feat 這類階梯少了功能層,或 fix 寫成多層。
# 照 stderr 的訊息修分支名再重跑,不要退回 develop。
# 8=(--derive 模式)推導出的基底不在 origin 上,而且它不是可以自動建立的功能主幹。
# 先把那條分支建出來並推上 origin,再重跑。
# 9=(--derive 模式)自動建立功能主幹失敗:origin 上沒有 develop,或推送被拒。
# 先建好 develop,或確認推送權限,再重跑。
set -u
MODE=caller
+6 -1
View File
@@ -4,7 +4,12 @@
# 規則: 全部轉小寫,非 a-z0-9 的字元換成連字號,
# 連續連字號合併成一個,並去除開頭與結尾的連字號。
# 輸出: {type}/{slug}(例如: slugify.sh feat "export report" → feat/export-report)
# 護欄: 輸入含非 ASCII 字元回傳 2;slug 化後為空回傳 3。兩者都印繁中錯誤到 stderr。
# 結束碼: 0=stdout 印出 {type}/{slug},直接拿去當分支名。
# 1=參數少於兩個。補上 type 與 phrase 再重跑。
# 2=type 或 phrase 含非 ASCII 字元。先把描述翻成英文短語再重跑,
# 不要自己動手拼分支名。
# 3=phrase slug 化之後是空字串(裡面一個 a-z0-9 都沒有)。換一句英文短語再重跑。
# 錯誤訊息都印到 stderr,其中 2 與 3 印繁體中文。
set -u
if [ "$#" -lt 2 ]; then