掌握編寫有效的GitHub提交信息的藝術(shù)
寫提交信息沒有嚴格的規(guī)則,但當在GitHub上做項目時,清楚、簡潔地傳達你所做的修改是很重要的。做到這一點的方法之一是在提交信息中使用關(guān)鍵字。
這些關(guān)鍵詞,或標簽,有助于表明變化的性質(zhì),使其他人更容易理解你的貢獻的背景。
以下是一些常見的關(guān)鍵詞和它們所表示的內(nèi)容。
FEAT:使用這個關(guān)鍵詞來表示你正在致力于一項新的功能。
FIX:使用這個關(guān)鍵詞表示你正在對一個特定的問題或議題進行修復。
STYLE: 使用這個關(guān)鍵詞表示你正在對代碼的風格或格式進行修改,而不是對其功能進行修改。
REFACTOR: 使用這個關(guān)鍵詞表示你正在對代碼進行修改,改善其結(jié)構(gòu)或組織,但不增加新的功能或修復錯誤。
TEST: 使用這個關(guān)鍵字表示你正在為代碼添加或更新測試。
CHORE:使用這個關(guān)鍵詞表示你正在對構(gòu)建過程或其他與代碼本身沒有直接關(guān)系的任務(wù)進行修改。
PERF:使用這個關(guān)鍵詞表示你正在進行修改以提高代碼的性能。
CI:使用這個關(guān)鍵詞表示你正在對持續(xù)集成過程進行修改。
BUILD:使用這個關(guān)鍵詞表示你正在對構(gòu)建過程進行修改。
通過在你的提交信息中使用這些關(guān)鍵詞,可以幫助使你的貢獻更清晰,更容易被他人理解。然而,需要注意的是,這些只是建議,并不是所有的項目都使用這些建議,如果團隊有自己的規(guī)范,那么應(yīng)該按自己的規(guī)范走。