import{_ as c}from"./plugin-vue_export-helper-DlAUqK2U.js";import{i as o,a as r,c as m,b as e,e as t,f as s,g as p,l as a,h}from"./app-CBehpE2h.js";const u={},v={href:"https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit",target:"_blank",rel:"noopener noreferrer"},g=h(`<h2 id="规范化格式" tabindex="-1"><a class="header-anchor" href="#规范化格式"><span>规范化格式</span></a></h2><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>&lt;type&gt;(&lt;scope&gt;): &lt;subject&gt;
// 空一行
&lt;body&gt;
// 空一行
&lt;footer&gt;
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container warning"><p class="hint-container-title">注意</p><p><code>Header</code>: 必需；<code>Body</code>, <code>Footer</code>: 可省略<br> 每行不超过 72 或 100 字符以防自动换行</p></div><h3 id="header" tabindex="-1"><a class="header-anchor" href="#header"><span>Header</span></a></h3><h4 id="type-提交的类型" tabindex="-1"><a class="header-anchor" href="#type-提交的类型"><span>type: 提交的类型</span></a></h4><table><thead><tr><th>type</th><th>描述</th></tr></thead><tbody><tr><td><code>feat</code></td><td>新功能（feature）</td></tr><tr><td><code>fix</code></td><td>修补 bug</td></tr><tr><td><code>docs</code></td><td>文档（documentation）</td></tr><tr><td><code>style</code></td><td>格式（不影响代码运行的变动）</td></tr><tr><td><code>refactor</code></td><td>重构（即不是新增功能，也不是修改 bug 的代码变动）</td></tr><tr><td><code>test</code></td><td>增加测试</td></tr><tr><td><code>chore</code></td><td>构建过程或辅助工具的变动</td></tr></tbody></table><div class="hint-container warning"><p class="hint-container-title">注意</p><p>若类型为<code>feat</code>或<code>fix</code>，则必须出现在<code>Change Log</code>中，其它改动建议不放入<code>Change Log</code></p></div><h4 id="scope-说明提交影响的范围" tabindex="-1"><a class="header-anchor" href="#scope-说明提交影响的范围"><span>scope: 说明提交影响的范围</span></a></h4><p>例如：数据层、控制层、视图层，<code>$location</code>, <code>$browser</code>, <code>$compile</code>, <code>$rootScope</code>, <code>ngHref</code>, <code>ngClick</code>, <code>ngView</code>等<br> 视项目不同而变化</p><div class="hint-container info"><p class="hint-container-title">提示</p><p>若修改影响不止一个<code>scope</code>，可使用<code>*</code>代替</p></div><h4 id="subject-改动目的的简短描述" tabindex="-1"><a class="header-anchor" href="#subject-改动目的的简短描述"><span>subject: 改动目的的简短描述</span></a></h4><p>要求：</p><ul><li>以动词开头，时态为第一人称现在时</li><li>首字母小写</li><li>不加句末标点</li></ul><h3 id="body-本次提交的详细描述" tabindex="-1"><a class="header-anchor" href="#body-本次提交的详细描述"><span>Body: 本次提交的详细描述</span></a></h3><p>要求：</p><ul><li>注意第二行是空行</li><li>以动词开头，时态为第一人称现在时</li><li>应该说明变动的动机，以及与之前的对比</li></ul><p>示例：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>More detailed explanatory text, if necessary.  Wrap it to
about 72 characters or so.

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="footer" tabindex="-1"><a class="header-anchor" href="#footer"><span>Footer</span></a></h3><p>只在两种情况下出现：</p><ul><li>不兼容变动：<code>BREAKING CHANGE</code>开头，内容为变动的描述、变动理由、迁移方法</li><li>关闭 Issue：针对某个或多个 Issue，内容为<code>Closes #issueId</code></li></ul><p>示例：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: &#39;attribute&#39;,
    }

    After:

    scope: {
      myAttr: &#39;@&#39;,
    }

    The removed \`inject\` wasn&#39;t generaly useful for directives so there should be no code using it.
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="特殊情况-revert" tabindex="-1"><a class="header-anchor" href="#特殊情况-revert"><span>特殊情况: Revert</span></a></h3><p>当前 commit 用于撤销以前的 commit， 则必须以<code>revert:</code>开头，后面跟着被撤销 commit 的 <code>&lt;Header&gt;</code></p><p>示例：</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>revert: feat(pencil): add &#39;graphiteWidth&#39; option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="规范化-commit-的优点" tabindex="-1"><a class="header-anchor" href="#规范化-commit-的优点"><span>规范化 commit 的优点</span></a></h2><p>可以快速查找信息：如使用<code>git log --grep [正则表达式]</code>快速查看改动</p>`,29),b={id:"规范化撰写工具-commitizen",tabindex:"-1"},_={class:"header-anchor",href:"#规范化撰写工具-commitizen"},f={href:"https://www.npmjs.com/package/commitizen",target:"_blank",rel:"noopener noreferrer"},x=e("h3",{id:"安装与配置",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#安装与配置"},[e("span",null,"安装与配置")])],-1),y=e("p",null,"安装（全局）",-1),k=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh","data-title":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"npm"),t(),e("span",{class:"token function"},"install"),t(),e("span",{class:"token parameter variable"},"-g"),t(` commitizen
`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),A=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh","data-title":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"yarn"),t(),e("span",{class:"token function"},"add"),t(),e("span",{class:"token parameter variable"},"-g"),t(` commitizen
`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),z=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh","data-title":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"pnpm"),t(),e("span",{class:"token function"},"add"),t(),e("span",{class:"token parameter variable"},"-g"),t(` commitizen
`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),C=e("p",null,"配置（在项目文件夹下）",-1),E=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh","data-title":"sh"},[e("pre",{class:"language-bash"},[e("code",null,`commitizen init cz-conventional-changelog --save-dev --save-exact
`)]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),w=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh","data-title":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[t("commitizen init cz-conventional-changelog "),e("span",{class:"token parameter variable"},"--yarn"),t(),e("span",{class:"token parameter variable"},"--dev"),t(),e("span",{class:"token parameter variable"},"--exact"),t(`
`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),j=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh","data-title":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[t("commitizen init cz-conventional-changelog "),e("span",{class:"token parameter variable"},"--pnpm"),t(` --save-dev --save-exact
`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),G=e("h3",{id:"使用",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#使用"},[e("span",null,"使用")])],-1),T=e("p",null,[t("用"),e("code",null,"cz"),t("或"),e("code",null,"git cz"),t("代替"),e("code",null,"git commit"),t("即可")],-1);function B(N,I){const d=o("ExternalLinkIcon"),l=o("CodeTabs");return r(),m("div",null,[e("p",null,[t("规范化的 git 提交信息便于阅读和查找，本文介绍"),e("a",v,[t("Angular 规范"),s(d)]),t(" （谷歌文档）")]),p(" more "),g,e("h2",b,[e("a",_,[e("span",null,[t("规范化撰写工具："),e("a",f,[t("commitizen"),s(d)])])])]),x,y,s(l,{id:"202",data:[{id:"npm"},{id:"yarn"},{id:"pnpm"}],active:2,"tab-id":"sync"},{title0:a(({value:i,isActive:n})=>[t("npm")]),title1:a(({value:i,isActive:n})=>[t("yarn")]),title2:a(({value:i,isActive:n})=>[t("pnpm")]),tab0:a(({value:i,isActive:n})=>[k]),tab1:a(({value:i,isActive:n})=>[A]),tab2:a(({value:i,isActive:n})=>[z]),_:1}),C,s(l,{id:"216",data:[{id:"npm"},{id:"yarn"},{id:"pnpm"}],active:2,"tab-id":"sync"},{title0:a(({value:i,isActive:n})=>[t("npm")]),title1:a(({value:i,isActive:n})=>[t("yarn")]),title2:a(({value:i,isActive:n})=>[t("pnpm")]),tab0:a(({value:i,isActive:n})=>[E]),tab1:a(({value:i,isActive:n})=>[w]),tab2:a(({value:i,isActive:n})=>[j]),_:1}),G,T])}const L=c(u,[["render",B],["__file","commit规范.html.vue"]]),O=JSON.parse('{"path":"/posts/%E5%B7%A5%E5%85%B7/Git/commit%E8%A7%84%E8%8C%83.html","title":"Git - Commit 规范","lang":"zh-CN","frontmatter":{"title":"Git - Commit 规范","cover":"/assets/images/cover19.jpg","icon":"icomoon-free:git","order":19,"author":"Kamimika","date":"2024-07-13T00:00:00.000Z","category":["Git"],"tag":["Git","规范","笔记"],"star":true,"description":"规范化的 git 提交信息便于阅读和查找，本文介绍Angular 规范 （谷歌文档）","head":[["meta",{"property":"og:url","content":"https://kamimika.top/posts/%E5%B7%A5%E5%85%B7/Git/commit%E8%A7%84%E8%8C%83.html"}],["meta",{"property":"og:site_name","content":"Kamimika 的个人小站"}],["meta",{"property":"og:title","content":"Git - Commit 规范"}],["meta",{"property":"og:description","content":"规范化的 git 提交信息便于阅读和查找，本文介绍Angular 规范 （谷歌文档）"}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://kamimika.top/assets/images/cover19.jpg"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2024-09-03T14:55:30.000Z"}],["meta",{"name":"twitter:card","content":"summary_large_image"}],["meta",{"name":"twitter:image:src","content":"https://kamimika.top/assets/images/cover19.jpg"}],["meta",{"name":"twitter:image:alt","content":"Git - Commit 规范"}],["meta",{"property":"article:author","content":"Kamimika"}],["meta",{"property":"article:tag","content":"Git"}],["meta",{"property":"article:tag","content":"规范"}],["meta",{"property":"article:tag","content":"笔记"}],["meta",{"property":"article:published_time","content":"2024-07-13T00:00:00.000Z"}],["meta",{"property":"article:modified_time","content":"2024-09-03T14:55:30.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Git - Commit 规范\\",\\"image\\":[\\"https://kamimika.top/assets/images/cover19.jpg\\"],\\"datePublished\\":\\"2024-07-13T00:00:00.000Z\\",\\"dateModified\\":\\"2024-09-03T14:55:30.000Z\\",\\"author\\":[{\\"@type\\":\\"Person\\",\\"name\\":\\"Kamimika\\"}]}"]]},"headers":[{"level":2,"title":"规范化格式","slug":"规范化格式","link":"#规范化格式","children":[{"level":3,"title":"Header","slug":"header","link":"#header","children":[]},{"level":3,"title":"Body: 本次提交的详细描述","slug":"body-本次提交的详细描述","link":"#body-本次提交的详细描述","children":[]},{"level":3,"title":"Footer","slug":"footer","link":"#footer","children":[]},{"level":3,"title":"特殊情况: Revert","slug":"特殊情况-revert","link":"#特殊情况-revert","children":[]}]},{"level":2,"title":"规范化 commit 的优点","slug":"规范化-commit-的优点","link":"#规范化-commit-的优点","children":[]},{"level":2,"title":"规范化撰写工具：commitizen","slug":"规范化撰写工具-commitizen","link":"#规范化撰写工具-commitizen","children":[{"level":3,"title":"安装与配置","slug":"安装与配置","link":"#安装与配置","children":[]},{"level":3,"title":"使用","slug":"使用","link":"#使用","children":[]}]}],"git":{"createdTime":1720866941000,"updatedTime":1725375330000,"contributors":[{"name":"wzh656","email":"1826632591@qq.com","commits":3}]},"readingTime":{"minutes":2.59,"words":777},"filePathRelative":"posts/工具/Git/commit规范.md","localizedDate":"2024年7月13日","excerpt":"<p>规范化的 git 提交信息便于阅读和查找，本文介绍<a href=\\"https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\">Angular 规范</a> （谷歌文档）</p>\\n","autoDesc":true}');export{L as comp,O as data};
