掌握編寫有效的GitHub提交資訊的藝術

前端小智發表於2023-02-08
本文首發於微信公眾號:大遷世界, 我的微信:qq449245884,我會第一時間和你分享前端行業趨勢,學習途徑等等。
更多開源作品請看 GitHub https://github.com/qq449245884/xiaozhi ,包含一線大廠面試完整考點、資料以及我的系列文章。

寫提交資訊沒有嚴格的規則,但當在GitHub上做專案時,清楚、簡潔地傳達你所做的修改是很重要的。做到這一點的方法之一是在提交資訊中使用關鍵字。

這些關鍵詞,或標籤,有助於表明變化的性質,使其他人更容易理解你的貢獻的背景。

以下是一些常見的關鍵詞和它們所表示的內容。

FEAT:使用這個關鍵詞來表示你正在致力於一項新的功能。

"FEAT: Add new login functionality."

FIX:使用這個關鍵詞表示你正在對一個特定的問題或議題進行修復。

"FIX: Fix bug causing crashes on certain devices."

STYLE: 使用這個關鍵詞表示你正在對程式碼的風格或格式進行修改,而不是對其功能進行修改。

"STYLE: Update indentation in main.js."

REFACTOR: 使用這個關鍵詞表示你正在對程式碼進行修改,改善其結構或組織,但不增加新的功能或修復錯誤。

"REFACTOR: Refactor the code to improve readability."

TEST: 使用這個關鍵字表示你正在為程式碼新增或更新測試。

"TEST: Add new unit tests for login functionality."

CHORE:使用這個關鍵詞表示你正在對構建過程或其他與程式碼本身沒有直接關係的任務進行修改。

"CHORE: Update dependencies in package.json."

PERF:使用這個關鍵詞表示你正在進行修改以提高程式碼的效能。

"PERF: Optimize image loading for faster performance."

CI:使用這個關鍵詞表示你正在對持續整合過程進行修改。

"CI: Fix issue with test pipeline on Dashboard CI."

BUILD:使用這個關鍵詞表示你正在對構建過程進行修改。

"BUILD: Add new script for building the production version of the app."

透過在你的提交資訊中使用這些關鍵詞,可以幫助使你的貢獻更清晰,更容易被他人理解。然而,需要注意的是,這些只是建議,並不是所有的專案都使用這些建議,如果團隊有自己的規範,那麼應該按自己的規範走。

程式碼部署後可能存在的BUG沒法實時知道,事後為了解決這些BUG,花了大量的時間進行log 除錯,這邊順便給大家推薦一個好用的BUG監控工具 Fundebug

交流

有夢想,有乾貨,微信搜尋 【大遷世界】 關注這個在凌晨還在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收錄,有一線大廠面試完整考點、資料以及我的系列文章。

相關文章