(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[71],{1485:function(e,t,n){(window.__NEXT_P=window.__NEXT_P||[]).push(["/contributing/commits",function(){return n(7727)}])},7727:function(e,t,n){"use strict";n.r(t),n.d(t,{Emojis:function(){return m},__N_SSG:function(){return h},default:function(){return p}});var s=n(5893),i=n(2818),o=n(3805),r=n(3693),a=n(1151);n(5675);let c=[{name:"contributing",children:[{name:"code-of-conduct",route:"/contributing/code-of-conduct"},{name:"commits",route:"/contributing/commits"},{name:"introduction",route:"/contributing/introduction"},{name:"issues",route:"/contributing/issues"},{name:"meta.json",meta:{introduction:"Introduction","code-of-conduct":"Code of conduct",issues:"Issues",commits:"Commits",pulls:"Pull requests"}},{name:"pulls",route:"/contributing/pulls"}],route:"/contributing"},{name:"index",route:"/"},{name:"kitchen",route:"/kitchen"},{name:"meta.json",meta:{index:"Introduction",kitchen:"Kitchen",contributing:"Contributing"}}];globalThis.__nextra_internal__={pageMap:c,route:"/contributing/commits"};let l=(0,s.jsx)(function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},{wrapper:t}=Object.assign({},(0,a.ah)(),e.components);return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)},{}),d=(0,o.withSSG)((0,i.Z)({filename:"commits.mdx",route:"/contributing/commits",meta:{},pageMap:c,titleText:"Commits",headings:[{type:"heading",depth:1,children:[{type:"text",value:"Commits",position:{start:{line:46,column:3,offset:1217},end:{line:46,column:10,offset:1224}}}],position:{start:{line:46,column:1,offset:1215},end:{line:46,column:10,offset:1224}},value:"Commits"},{type:"heading",depth:2,children:[{type:"text",value:"Structure",position:{start:{line:51,column:4,offset:1689},end:{line:51,column:13,offset:1698}}}],position:{start:{line:51,column:1,offset:1686},end:{line:51,column:13,offset:1698}},value:"Structure"},{type:"heading",depth:2,children:[{type:"text",value:"Gitmojis",position:{start:{line:80,column:4,offset:2196},end:{line:80,column:12,offset:2204}}}],position:{start:{line:80,column:1,offset:2193},end:{line:80,column:12,offset:2204}},value:"Gitmojis"},{type:"heading",depth:2,children:[{type:"text",value:"Types",position:{start:{line:87,column:4,offset:2507},end:{line:87,column:9,offset:2512}}}],position:{start:{line:87,column:1,offset:2504},end:{line:87,column:9,offset:2512}},value:"Types"},{type:"heading",depth:2,children:[{type:"text",value:"Description",position:{start:{line:104,column:4,offset:3046},end:{line:104,column:15,offset:3057}}}],position:{start:{line:104,column:1,offset:3043},end:{line:104,column:15,offset:3057}},value:"Description"},{type:"heading",depth:2,children:[{type:"text",value:"Issue number",position:{start:{line:116,column:4,offset:3294},end:{line:116,column:16,offset:3306}}}],position:{start:{line:116,column:1,offset:3291},end:{line:116,column:16,offset:3306}},value:"Issue number"},{type:"heading",depth:2,children:[{type:"text",value:"Body",position:{start:{line:124,column:4,offset:3476},end:{line:124,column:8,offset:3480}}}],position:{start:{line:124,column:1,offset:3473},end:{line:124,column:8,offset:3480}},value:"Body"}],hasH1:!0},r.Z));var h=!0;let m=()=>{let e=Object.assign({div:"div",table:"table",thead:"thead",tr:"tr",th:"th",tbody:"tbody",td:"td"},(0,a.ah)()),{emojis:t}=(0,o.useSSG)();return(0,s.jsx)(e.div,{className:"table-container",children:(0,s.jsxs)(e.table,{children:[(0,s.jsx)(e.thead,{children:(0,s.jsxs)(e.tr,{children:[(0,s.jsx)(e.th,{children:"Emoji"}),(0,s.jsx)(e.th,{children:"Code"}),(0,s.jsx)(e.th,{children:"Description"})]})}),(0,s.jsx)(e.tbody,{children:t.map(t=>(0,s.jsxs)(e.tr,{children:[(0,s.jsx)(e.td,{style:{textAlign:"center"},children:t.emoji}),(0,s.jsx)(e.td,{children:t.code}),(0,s.jsx)(e.td,{children:t.description})]},t.code))})]})})};function u(e){let t=Object.assign({h1:"h1",p:"p",a:"a",h2:"h2",strong:"strong",pre:"pre",code:"code",div:"div",span:"span",table:"table",thead:"thead",tr:"tr",th:"th",tbody:"tbody",td:"td"},(0,a.ah)(),e.components);return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{children:"Commits"}),"\n",(0,s.jsxs)(t.p,{children:["Many companies don't pay attention to conventional commits, we do, because we like to have a clean project history and workflows to read. Most of us use ",(0,s.jsx)(t.a,{href:"https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph",children:"Git Graph"}),", an extension that allows us to read our Git history as a graph.\nOur commits convention is inspired by ",(0,s.jsx)(t.a,{href:"https://www.conventionalcommits.org/en/v1.0.0",children:"Conventional Commits 1.0.0"})," but customized into something more fun! \uD83D\uDE04"]}),"\n",(0,s.jsx)(t.h2,{id:"structure",children:"Structure"}),"\n",(0,s.jsxs)(t.p,{children:["The commit message should be structured as follows and ",(0,s.jsx)(t.strong,{children:"in lowercase"}),":"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:"<gitmoji> <type> <description> [(#<issue number>)]\n\n[optional body]\n\n[optional footer(s)]\n"})}),"\n",(0,s.jsx)(t.p,{children:"Example:"}),"\n",(0,s.jsx)(t.div,{"data-rehype-pretty-code-fragment":"","data-nextra-code":"",children:(0,s.jsx)(t.pre,{children:(0,s.jsxs)(t.code,{"data-language":"bash","data-theme":"default",children:[(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"\uD83D\uDCDD update documentation contributors"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"- Add @jerembdn as a contributor"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"- Add @younesbessa as a contributor"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsxs)(t.span,{className:"line",children:[(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"Co-authored-by: Younes Bessa "}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"<"}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"younes@onruntime.com"}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:">"})]})]})})}),"\n",(0,s.jsx)(t.p,{children:"But most of the time we avoid wasting a lot of time on it so it looks more like this:"}),"\n",(0,s.jsx)(t.div,{"data-rehype-pretty-code-fragment":"","data-nextra-code":"",children:(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{"data-language":"bash","data-theme":"default",children:(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"\uD83D\uDCDD update documentation contributors"})})})})}),"\n",(0,s.jsx)(t.h2,{id:"gitmojis",children:"Gitmojis"}),"\n",(0,s.jsxs)(t.p,{children:["We use ",(0,s.jsx)(t.a,{href:"https://gitmoji.dev",children:"gitmoji"})," to categorize our commits, it has a good ecosystem and is very easy to use on a daily basis using ",(0,s.jsx)(t.a,{href:"https://gitmoji.dev/related-tools",children:"these tools"}),"."]}),"\n",(0,s.jsx)(t.p,{children:"Otherwise here is the complete list of these emojis, their code and the description given to them:"}),"\n",(0,s.jsx)(m,{}),"\n",(0,s.jsx)(t.h2,{id:"types",children:"Types"}),"\n",(0,s.jsx)(t.p,{children:"We use the following commit types:"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"add"})}),(0,s.jsx)(t.td,{children:"Add a new feature"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"fix"})}),(0,s.jsx)(t.td,{children:"Fix a bug"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"improve"})}),(0,s.jsx)(t.td,{children:"Improve something"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"update"})}),(0,s.jsx)(t.td,{children:"Update something"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"remove"})}),(0,s.jsx)(t.td,{children:"Remove something"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"refactor"})}),(0,s.jsx)(t.td,{children:"Refactor something"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"rename"})}),(0,s.jsx)(t.td,{children:"Rename something"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"move"})}),(0,s.jsx)(t.td,{children:"Move a file or folder"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"upgrade"})}),(0,s.jsx)(t.td,{children:"Upgrade dependencies"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:"downgrade"})}),(0,s.jsx)(t.td,{children:"Downgrade dependencies"})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"description",children:"Description"}),"\n",(0,s.jsx)(t.p,{children:"The description should be a short description of the commit, it should be written in the imperative, present tense. For example:"}),"\n",(0,s.jsx)(t.div,{"data-rehype-pretty-code-fragment":"","data-nextra-code":"",children:(0,s.jsx)(t.pre,{children:(0,s.jsxs)(t.code,{"data-language":"bash","data-theme":"default",children:[(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-comment)"},children:"# Good"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"\uD83D\uDCDD update documentation contributors"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-comment)"},children:"# Bad"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"\uD83D\uDCDD updated documentation contributors"})})]})})}),"\n",(0,s.jsx)(t.h2,{id:"issue-number",children:"Issue number"}),"\n",(0,s.jsx)(t.p,{children:"If the commit is related to an issue, you can add the issue number at the end of the description, for example:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:"\uD83D\uDCDD update documentation contributors (#123)\n"})}),"\n",(0,s.jsx)(t.h2,{id:"body",children:"Body"}),"\n",(0,s.jsx)(t.p,{children:"The body should include the motivation for the change and contrast this with previous behavior. It should be written in the imperative, present tense. For example:"}),"\n",(0,s.jsx)(t.div,{"data-rehype-pretty-code-fragment":"","data-nextra-code":"",children:(0,s.jsx)(t.pre,{children:(0,s.jsxs)(t.code,{"data-language":"bash","data-theme":"default",children:[(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-comment)"},children:"# Good"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"\uD83D\uDCDD update documentation contributors"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"- Add @jerembdn as a contributor"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"- Add @younesbessa as a contributor"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsxs)(t.span,{className:"line",children:[(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"Co-authored-by: Younes Bessa "}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"<"}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"younes@onruntime.com"}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:">"})]}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-comment)"},children:"# Bad"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"\uD83D\uDCDD update documentation contributors"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"- Added @jerembdn as a contributor"})}),"\n",(0,s.jsx)(t.span,{className:"line",children:(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"- Added @younesbessa as a contributor"})}),"\n",(0,s.jsx)(t.span,{className:"line"}),"\n",(0,s.jsxs)(t.span,{className:"line",children:[(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"Co-authored-by: Younes Bessa "}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"<"}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"younes@onruntime.com"}),(0,s.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:">"})]})]})})})]})}function p(e){return(0,s.jsx)(d,{...e,children:l})}p.getLayout=d.getLayout},3693:function(e,t,n){"use strict";n.d(t,{Z:function(){return l}});var s=n(5893),i=n(9521);let o=i.ZP.div.withConfig({componentId:"sc-4982e730-0"})(["position:relative;height:100%;display:flex;align-items:center;filter:brightness(0.75);transition:all 0.2s;:hover{filter:brightness(1);}"]),r=i.ZP.img.withConfig({componentId:"sc-4982e730-1"})(["height:30px;width:auto;transform:scale(0.75);"]),a=i.ZP.h1.withConfig({componentId:"sc-4982e730-2"})(["position:absolute;font-size:18px;right:-350%;@media (max-width:768px){display:none;}"]);var c=n(794),l={github:"https://github.com/onRuntime/onruntime-docs",docsRepositoryBase:"https://github.com/onRuntime/onruntime-docs/blob/master",titleSuffix:" | onRuntime Studio",projectChatLink:"https://discord.gg/ucX9c5yXmX",logo:(0,s.jsx)(()=>(0,s.jsxs)(o,{children:[(0,s.jsx)(r,{src:"https://onruntime.com/static/images/logo/onruntime.svg",draggable:!1,height:48,width:48}),(0,s.jsx)(a,{children:"onRuntime"})]}),{}),head:e=>{let{title:t="onRuntime Studio",meta:n}=e,i=n.description||"Studio that brings together teams of creators and develops applications, website and game platforms.",o=(0,c.ZP)("https://og-image.onruntime.com/".concat(t,".jpeg"),{description:i,theme:"dark",md:1,fontSize:"100px",images:"https://onruntime.com/static/images/logo/onruntime.svg"});return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("meta",{name:"msapplication-TileColor",content:"#ffffff"}),(0,s.jsx)("meta",{httpEquiv:"Content-Language",content:"en"}),(0,s.jsx)("meta",{name:"description",content:i}),(0,s.jsx)("meta",{name:"og:description",content:i}),(0,s.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,s.jsx)("meta",{name:"twitter:site",content:"@onRuntime"}),(0,s.jsx)("meta",{name:"twitter:image",content:o}),(0,s.jsx)("meta",{name:"og:title",content:t?t+" | onRuntime":"onRuntime Studio"}),(0,s.jsx)("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),(0,s.jsx)("meta",{name:"description",content:i}),(0,s.jsx)("meta",{name:"og:title",content:t}),(0,s.jsx)("meta",{name:"og:image",content:o})]})},search:!0,defaultMenuCollapsed:!0,prevLinks:!0,nextLinks:!0,footer:!0,floatTOC:!0,footerEditLink:"Edit this page on GitHub",footerText:(0,s.jsx)(()=>(0,s.jsxs)(s.Fragment,{children:["\xa9 ",new Date().getFullYear()," onRuntime Studio"]}),{}),feedbackLabels:"feedback",feedbackLink:"Feedback",unstable_faviconGlyph:"\uD83D\uDC4B",unstable_flexsearch:!0}},4654:function(){}},function(e){e.O(0,[737,774,888,179],function(){return e(e.s=1485)}),_N_E=e.O()}]);