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