當使用者想要建立重構請求時,將呼叫此技能。您應遵循以下步驟。若您認為某些步驟非必要,可予以跳過。
-
請使用者提供他們想要解決之問題的詳細、冗長描述,以及任何潛在的解決方案想法。
-
探索儲存庫以驗證他們的陳述,並了解程式碼庫的當前狀態。
-
詢問使用者是否考慮過其他選項,並向他們提出其他選項。
-
針對實作方式訪談使用者。請極度詳細且全面地進行。
-
確定實作的確切範圍。釐清您計劃變更的內容以及您計劃不變更的內容。
-
在程式碼庫中檢查該區域的測試覆蓋率。如果測試覆蓋率不足,請詢問使用者的測試計劃。
-
將實作分解為一系列極小的提交。謹記 Martin Fowler 的建議:「讓每個重構步驟盡可能小,以便您始終能看到程式運作。」
-
使用重構計劃建立一個 GitHub Issue。請使用以下範本作為 Issue 描述:
問題陳述
開發者面臨的問題,從開發者的角度來看。
解決方案
問題的解決方案,從開發者的角度來看。
提交
一份詳細、冗長的實作計劃。請以純英文撰寫計劃,將實作分解為最細小的提交。每個提交都應使程式碼庫保持在可運作狀態。
決策文件
已做出的實作決策列表。可包含:
- 將建置/修改的模組
- 將修改的模組介面
- 來自開發者的技術說明
- 架構決策
- 架構變更
- API 合約
- 具體互動
請勿包含具體的檔案路徑或程式碼片段。它們可能很快就會過時。
測試決策
已做出的測試決策列表。請包含:
- 什麼是好的測試的描述(僅測試外部行為,而非實作細節)
- 將測試哪些模組
- 測試的先前範例(即程式碼庫中類似的測試類型)
範圍外事項
此重構範圍外之事項的描述。
進一步備註(可選)
任何關於重構的進一步備註。