当前位置: 首页 > Linux

提醒!你可能忽略的Git提交规范

时间:2023-04-06 11:20:54 Linux

1.涓轰粈涔堥渶瑕佽鑼冿紵娌℃湁瑙勭煩灏辨病鏈夎鐭╋紝缂栫▼涔熶竴鏍枫€傚鏋滀綘鏈変竴涓」鐩紝浣犱粠澶村埌灏鹃兘鏄嚜宸卞啓鐨勶紝浣犳兂鎬庝箞鍐欏氨鎬庝箞鍐欙紝璋佷篃涓嶈兘骞叉秹銆備絾鏄鏋滄瘡涓汉閮藉湪鍥㈤槦鍚堜綔涓〃鐜板嚭鑷繁鐨勪釜鎬э紝閭d箞浠g爜灏变細涔变竷鍏碂锛屼竴涓ソ鐨勯」鐩篃浼氭瘉浜庝竴鏃︺€傛棤璁烘槸寮€鍙戣繕鏄互鍚庣殑缁存姢锛岄兘浼氭槸涓€鍦虹伨闅俱€傝繖鏃跺€欐湁浜烘彁鍑轰负浠€涔堜笉缁熶竴鏍囧噯锛屽ぇ瀹堕兘鎸夌収杩欎釜鏍囧噯鏉ュ仛銆備簬鏄紝ESLint銆丣SHint绛変唬鐮佸伐鍏峰闆ㄥ悗鏄ョ瑡鑸秾鐜帮紝鎴愪负椤圭洰寤鸿鐨勫繀澶囦骇鍝併€侴itCommit瑙勮寖鍙兘娌℃湁閭d箞澶稿紶锛屼絾濡傛灉浣犲湪鐗堟湰鍥炴粴鏃剁湅鍒板緢澶氶敊璇殑鎻愪氦锛屾亹鎬曚綘浼氬緢鐢熸皵銆傛墍浠ワ紝涓ユ牸閬靛畧瑙勮寖锛屽埄浜哄埄宸便€?銆佸叿浣撹鍒欏厛鐪嬩竴涓嬪叕寮忥細():type鐢ㄦ潵鎻忚堪commit鐨勭被鍨嬶紝鍙厑璁告湁浠ヤ笅7涓爣蹇椼€俧eat:newfunction锛堢壒鎬э級fix:fixbugdocs:documentation锛堟枃妗o級style:format锛堜笉褰卞搷浠g爜杩愯鐨勫彉鍖栵級refactor:閲嶆瀯锛堜笉鏄柊鐗规€э紝涔熶笉鏄慨鏀筨ug鐨勪唬鐮佸彉鍖栵級test:addtestschore:The鏋勫缓杩囩▼鎴栬緟鍔╁伐鍏蜂腑鐨勫彉鏇磋寖鍥寸敤浜庤鏄巆ommit褰卞搷鐨勮寖鍥达紝濡傛暟鎹眰銆佹帶鍒跺眰銆佽鍥惧眰绛夛紝瑙嗛」鐩€屽畾銆俿ubject鏄鎻愪氦鐩殑鐨勭畝鐭弿杩帮紝涓嶈秴杩?0涓瓧绗︺€備互鍔ㄨ瘝寮€澶达紝浣跨敤绗竴浜虹О鐜板湪鏃讹紝渚嬪change锛岃€屼笉鏄痗hanged鎴朿hanges銆傚皬鍐欑粨灏剧殑绗竴涓瓧姣嶄笉鍔犲彞鐐?.)3.寮傚父澶勭悊鎴戜滑鏉ョ湅鐪嬭繖涓紓甯告彁绀猴細INVALIDCOMMITMSG:doesnotmatch"():"锛乯artto:fixbug涔嬫墍浠ユ姤杩欎釜warning杩欓噷鏄洜涓烘垜鐨勬彁浜ゆ湁涓や釜闂锛氱涓€锛屼娇鐢ㄤ簡瑙勮寖涔嬪鐨勫叧閿瘝锛涚浜岋紝寰堣缁嗙殑闂锛宩artto:鏈熬灏戜簡涓€涓┖鏍硷紱鎵嶆兂璧锋潵褰撴椂涓€鐩存彁浜ゅけ璐ワ紝杩笉寰楀凡鐩存帴浠撲績鎻愪氦锛屾墍浠ヤ互鍚庣殑鎻愪氦閮戒細hold杩欎釜exception銆傚ぇ鑷存剰鎬濆氨鏄細浣犱箣鍓嶇殑Commit涓嶅悎鏍紐浣犱箣鍓嶇殑Commit涓嶅悎鏍紐浣犱箣鍓嶇殑Commit涓嶅悎鏍艰繖鏃跺€欏氨寰堢儲浜轰簡锛屾垜浠彧鑳芥敼姝d箣鍓嶇殑閿欒锛岄偅鎬庝箞鎿嶄綔鍛紵鍥涖€佸浣曚慨鏀逛箣鍓嶇殑commit淇℃伅锛熷叾瀹炲苟涓嶅鏉傦紝鎴戜滑鍙渶瑕佽繖鏍峰仛锛?.鏆傛椂瀛樺偍涓庡綋鍓嶅垎鏀棤鍏崇殑宸ヤ綔鐘舵€乬itstash2.灏咹EAD绉诲姩鍒伴渶瑕佷慨鏀圭殑commitgitrebase9633cf0919^--interactive3.鎵惧埌闇€瑕佷慨鏀圭殑commit锛屾妸绗竴琛岀殑pick鏀规垚edit4锛屽紑濮嬭В鍐充綘鐨刡ug5锛実itadd鎶婁慨鏀圭殑鏂囦欢娣诲姞鍒版殏瀛?锛実itcommit鈥揳mendappendthechanges鍒癱ommit7锛実itrebase鈥撶户缁妸HEAD绉诲洖鏈€鏂扮殑commit8锛屾仮澶嶄箣鍓峠itstashpop鐨勫伐浣滅姸鎬佹槸complete锛岃涓嶈鍐嶄慨鏀规暣涓狢ommit锛宔scape~5锛屽湪椤圭洰涓娇鐢ㄨ繖鏃讹紝闂鍙堟潵浜嗭紝涓轰粈涔堟彁浜ょ殑鏃跺€欐湁璀﹀憡锛屾€庝箞鍔烇紵杩欐椂鍊欐垜浠氨闇€瑕佷竴涓狽ode鎻掍欢validate-commit-msg鏉ユ娴嬮」鐩腑鐨凜ommit娑堟伅鏄惁瑙勮寖銆?.棣栧厛瀹夎鎻掍欢锛歯pminstall--save-devvalidate-commit-msg2.浣跨敤鏂规硶涓€锛屽垱寤轰竴涓?vcmrc鏂囦欢锛歿"types":["feat","fix","docs",鈥滄牱寮忊€濄€佲€滈噸鏋勨€濄€佲€滄€ц兘鈥濄€佲€滄祴璇曗€濄€佲€滄瀯寤衡€濄€佲€渃i鈥濄€佲€滄潅鍔♀€濄€佲€滆繕鍘熲€漖銆佲€滆寖鍥粹€濓細{鈥滃繀闇€鈥濓細鍋囥€佲€滃厑璁糕€濓細[鈥?"],"validate":false,"multiple":false},"warnOnFail":false,"maxSubjectLength":100,"subjectPattern":".+","subjectPatternErrorMsg":"涓婚涓庝富棰樻ā寮忎笉鍖归厤锛?,"helpMessage":"","autoFix":false}3.浣跨敤鏂规硶浜岋細鍐欏叆package.json{"config":{"validate-commit-msg":{/*yourconfighere*/}}}4銆佷絾鏄鏋滄垜浠兂鑷姩浣跨敤ghookshook鍑芥暟鎬庝箞鍔烇紵{...鈥渃onfig鈥濓細{鈥済hooks鈥濓細{鈥減re-commit鈥濓細鈥済ulplint鈥濓紝鈥渃ommit-msg鈥濓細鈥渧alidate-commit-msg鈥濓紝鈥減re-push鈥濓細鈥滆繘琛屾祴璇曗€濓紝"post-merge":"npminstall","post-rewrite":"npminstall",鈥}}鈥鎴戜滑鍙互鍦╣hooks涓仛寰堝浜嬫儏锛屽綋鐒朵笉浠呬粎鏄痸alidate-commit-msg銆傛洿澶氱粏鑺傝鍙傝€冿細https://github.com/convention...鍏€丆ommit瑙勮寖鐨勪綔鐢?銆佹彁渚涙洿澶氫俊鎭紝鏂逛究鏁呴殰鎺掗櫎鍜屽洖婊氾紱2.杩囨护鍏抽敭璇嶏紝蹇€熷畾浣嶏紱3.鏂逛究鐢熸垚鏂囦欢锛?.GenerateChangelog涓婇潰璇翠簡鐢熸垚鏂囨。锛屽鏋滄垜浠殑鎻愪氦鏄寜鐓ц鑼冩潵鐨勶紝閭e氨寰堢畝鍗曚簡銆傜敓鎴愮殑鏂囨。鍖呮嫭浠ヤ笅涓変釜閮ㄥ垎锛氭柊鍔熻兘閿欒淇閲嶅ぇ鏇存敼銆傛瘡涓儴鍒嗛兘灏嗗垪鍑虹浉鍏崇殑鎻愪氦骞跺叿鏈夋寚鍚戣繖浜涙彁浜ょ殑閾炬帴銆傚綋鐒讹紝鐢熸垚鐨勬枃妗e厑璁告墜鍔ㄤ慨鏀癸紝鎵€浠ヤ綘鍙互鍦ㄥ彂甯冧箣鍓嶆坊鍔犲叾浠栧唴瀹广€傝繖閲岄渶瑕佷娇鐢ㄥ伐鍏稢onventionalChangelog鏉ョ敓鎴怌hangelog锛歯pminstall-gconventional-changelogcdjartto-domoconventional-changelog-pangular-iCHANGELOG.md-w涓轰簡鏂逛究锛屽彲浠ュ啓鍒皊cripts瀛楁package.json鐨勩€倇"scripts":{"changelog":"conventional-changelog-pangular-iCHANGELOG.md-w-r0"}}杩欐牱锛屼娇鐢ㄨ捣鏉ュ緢绠€鍗曪細npmrunchangelog濂戒簡锛屾垜浠墍鏈夌殑闂閮芥悶瀹氫簡out锛岎煃诲共鏉瘇8.鎬荤粨鐪嬪畬鏂囩珷锛屼綘杩樹細杩欎箞鏀捐崱涓嶇緛鍚楋紵浣犺繕浼氶殢蹇冩墍娆插湴鍐機ommit鍚楋紵浣犺繕浼氳繖鏍锋彁浜itcommit-m"helloworld"鍚楋紵绛旀鏄惁瀹氱殑锛屽洜涓轰娇鐢ㄤ簡閽╁瓙鍑芥暟锛屼綘娌℃湁鏈轰細锛屽惁鍒欎細娌″畬娌′簡鐨勫洖鏀禖ommit銆傝繖鏍峰彲浠ュ吇鎴愯壇濂界殑鎻愪氦涔犳儻~~鏉ヨ嚜锛欽artto鐨勫崥瀹㈤摼鎺ワ細http://jartto.wang/2018/07/08...

最新推荐
猜你喜欢