diff --git a/bun.lock b/bun.lock index 70ee727..502c222 100644 --- a/bun.lock +++ b/bun.lock @@ -7,6 +7,10 @@ "dependencies": { "@astrojs/sitemap": "^3.2.1", "astro": "^5.1.1", + "rehype-stringify": "^10.0.1", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.1.2", + "unified": "^11.0.5", }, "devDependencies": { "@tailwindcss/typography": "^0.5.16", diff --git a/docs/404.html b/docs/404.html index 5451fc9..d269979 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,4 +1,4 @@ - Page Not Found | Git Common Flow -

404

Page not found.

Go to the homepage

\ No newline at end of file +

+404 +

+Page not found +

+The page you're looking for doesn't exist. +

+Go to homepage +
\ No newline at end of file diff --git a/docs/_astro/_version_.BDyAzQHc.css b/docs/_astro/_version_.BDyAzQHc.css deleted file mode 100644 index 4ef9fb8..0000000 --- a/docs/_astro/_version_.BDyAzQHc.css +++ /dev/null @@ -1 +0,0 @@ -/*! tailwindcss v4.1.18 | MIT License | https://tailwindcss.com */@layer properties{@supports (((-webkit-hyphens:none)) and (not (margin-trim:inline))) or ((-moz-orient:inline) and (not (color:rgb(from red r g b)))){*,:before,:after,::backdrop{--tw-rotate-x:initial;--tw-rotate-y:initial;--tw-rotate-z:initial;--tw-skew-x:initial;--tw-skew-y:initial;--tw-border-style:solid;--tw-duration:initial}}}@layer theme{:root,:host{--font-sans:"Open Sans",Helvetica,Arial,sans-serif;--font-mono:"SFMono-Regular",Consolas,"Liberation Mono",Menlo,Courier,monospace;--color-white:#fff;--spacing:.25rem;--default-transition-duration:.15s;--default-transition-timing-function:cubic-bezier(.4,0,.2,1);--default-font-family:var(--font-sans);--default-mono-font-family:var(--font-mono);--color-text-primary:#1a1a1a;--color-text-muted:#999;--color-bg-primary:#fdfdfd;--color-bg-code:#f6f8fa;--color-bg-code-inline:#1b1f230d;--color-dark-text-primary:#e5e5e5;--color-dark-bg-primary:#0d0d0d;--color-dark-bg-code:#1a1a1a;--color-dark-bg-code-inline:#ffffff1a;--font-heading:"Open Sans Condensed",Helvetica,Arial,sans-serif}}@layer base{*,:after,:before,::backdrop{box-sizing:border-box;border:0 solid;margin:0;padding:0}::file-selector-button{box-sizing:border-box;border:0 solid;margin:0;padding:0}html,:host{-webkit-text-size-adjust:100%;tab-size:4;line-height:1.5;font-family:var(--default-font-family,ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji");font-feature-settings:var(--default-font-feature-settings,normal);font-variation-settings:var(--default-font-variation-settings,normal);-webkit-tap-highlight-color:transparent}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;-webkit-text-decoration:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-family:var(--default-mono-font-family,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace);font-feature-settings:var(--default-mono-font-feature-settings,normal);font-variation-settings:var(--default-mono-font-variation-settings,normal);font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}:-moz-focusring{outline:auto}progress{vertical-align:baseline}summary{display:list-item}ol,ul,menu{list-style:none}img,svg,video,canvas,audio,iframe,embed,object{vertical-align:middle;display:block}img,video{max-width:100%;height:auto}button,input,select,optgroup,textarea{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}::file-selector-button{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}:where(select:is([multiple],[size])) optgroup{font-weight:bolder}:where(select:is([multiple],[size])) optgroup option{padding-inline-start:20px}::file-selector-button{margin-inline-end:4px}::placeholder{opacity:1}@supports (not ((-webkit-appearance:-apple-pay-button))) or (contain-intrinsic-size:1px){::placeholder{color:currentColor}@supports (color:color-mix(in lab,red,red)){::placeholder{color:color-mix(in oklab,currentcolor 50%,transparent)}}}textarea{resize:vertical}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-date-and-time-value{min-height:1lh;text-align:inherit}::-webkit-datetime-edit{display:inline-flex}::-webkit-datetime-edit-fields-wrapper{padding:0}::-webkit-datetime-edit{padding-block:0}::-webkit-datetime-edit-year-field{padding-block:0}::-webkit-datetime-edit-month-field{padding-block:0}::-webkit-datetime-edit-day-field{padding-block:0}::-webkit-datetime-edit-hour-field{padding-block:0}::-webkit-datetime-edit-minute-field{padding-block:0}::-webkit-datetime-edit-second-field{padding-block:0}::-webkit-datetime-edit-millisecond-field{padding-block:0}::-webkit-datetime-edit-meridiem-field{padding-block:0}::-webkit-calendar-picker-indicator{line-height:1}:-moz-ui-invalid{box-shadow:none}button,input:where([type=button],[type=reset],[type=submit]){appearance:button}::file-selector-button{appearance:button}::-webkit-inner-spin-button{height:auto}::-webkit-outer-spin-button{height:auto}[hidden]:where(:not([hidden=until-found])){display:none!important}html{height:100%}body{font-family:var(--font-sans);color:var(--color-text-primary);background-color:var(--color-bg-primary);font-size:16px;font-weight:400;line-height:1.5}.dark body{color:var(--color-dark-text-primary);background-color:var(--color-dark-bg-primary)}h1,h2,h3,h4,h5,h6{font-family:var(--font-heading);color:#333;font-weight:700}.dark h1,.dark h2,.dark h3,.dark h4,.dark h5,.dark h6{color:#e5e5e5}h1{font-size:2.5em;line-height:1.2}ol ol,ul ol{list-style-type:lower-roman}ul ul ol,ul ol ol,ol ul ol,ol ol ol{list-style-type:lower-alpha}a{word-break:break-word}code{background-color:var(--color-bg-code-inline);font-family:var(--font-mono);border-radius:3px;margin:0;padding:.3em .4em .1em;font-size:85%}.dark code{background-color:var(--color-dark-bg-code-inline)}pre{background-color:var(--color-bg-code);border-radius:3px;padding:16px;line-height:1.45}.dark pre{background-color:var(--color-dark-bg-code)}pre>code{border-radius:0;padding:0;font-size:90%;background-color:#0000!important}}@layer components{#layout,#menu,.menu-link{transition:all .2s ease-out}}@layer utilities{.visible{visibility:visible}.static{position:static}.flex{display:flex}.hidden{display:none}.h-6{height:calc(var(--spacing)*6)}.h-12{height:calc(var(--spacing)*12)}.w-6{width:calc(var(--spacing)*6)}.w-12{width:calc(var(--spacing)*12)}.transform{transform:var(--tw-rotate-x,)var(--tw-rotate-y,)var(--tw-rotate-z,)var(--tw-skew-x,)var(--tw-skew-y,)}.border{border-style:var(--tw-border-style);border-width:1px}.p-2{padding:calc(var(--spacing)*2)}.text-\[color\:var\(--color-text-muted\)\]{color:var(--color-text-muted)}.transition{transition-property:color,background-color,border-color,outline-color,text-decoration-color,fill,stroke,--tw-gradient-from,--tw-gradient-via,--tw-gradient-to,opacity,box-shadow,transform,translate,scale,rotate,filter,-webkit-backdrop-filter,backdrop-filter,display,content-visibility,overlay,pointer-events;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-colors{transition-property:color,background-color,border-color,outline-color,text-decoration-color,fill,stroke,--tw-gradient-from,--tw-gradient-via,--tw-gradient-to;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.duration-200{--tw-duration:.2s;transition-duration:.2s}@media(hover:hover){.hover\:text-white:hover{color:var(--color-white)}}}@property --tw-rotate-x{syntax:"*";inherits:false}@property --tw-rotate-y{syntax:"*";inherits:false}@property --tw-rotate-z{syntax:"*";inherits:false}@property --tw-skew-x{syntax:"*";inherits:false}@property --tw-skew-y{syntax:"*";inherits:false}@property --tw-border-style{syntax:"*";inherits:false;initial-value:solid}@property --tw-duration{syntax:"*";inherits:false}#menu[data-astro-cid-ssfzsv2f]{margin-left:-150px;width:150px;position:fixed;top:0;left:0;bottom:0;z-index:1000;background:#191818;overflow-y:auto;-webkit-overflow-scrolling:touch;transition:all .2s ease-out;display:flex;flex-direction:column}.menu-inner[data-astro-cid-ssfzsv2f]{flex:1}.menu-list[data-astro-cid-ssfzsv2f]{list-style:none;margin:0;padding:0;border:none;background:transparent;border-top:1px solid #333}.menu-label[data-astro-cid-ssfzsv2f]{color:#999;border:none;padding:.6em 0 .6em .6em;font-size:.9em}.menu-item[data-astro-cid-ssfzsv2f]{border:none}.menu-link-item[data-astro-cid-ssfzsv2f]{display:block;color:#999;border:none;padding:.6em 0 .6em .6em;text-decoration:none;transition:background-color .15s ease}.menu-link-item[data-astro-cid-ssfzsv2f]:hover,.menu-link-item[data-astro-cid-ssfzsv2f]:focus{background:#333}.menu-item[data-astro-cid-ssfzsv2f].selected{background:#1f8dd6}.menu-item[data-astro-cid-ssfzsv2f].selected .menu-link-item[data-astro-cid-ssfzsv2f]{color:#fff}.links[data-astro-cid-ssfzsv2f]{font-size:50px;padding:10px 0;text-align:center;display:flex;flex-direction:column;align-items:center;gap:.25rem}.github-link[data-astro-cid-ssfzsv2f]{color:#555;padding:0;position:relative;text-decoration:none;transition:color .15s ease}.github-link[data-astro-cid-ssfzsv2f]:hover{color:#777}@media(min-width:48em){#menu[data-astro-cid-ssfzsv2f]{left:150px}}#layout.active #menu[data-astro-cid-ssfzsv2f]{left:150px;width:150px}.menu-link[data-astro-cid-jyixok4n]{position:fixed;display:block;top:0;left:0;background:#000000b3;font-size:10px;z-index:10;width:2em;height:auto;padding:2.1em 1.6em;transition:all .2s ease-out}.menu-link[data-astro-cid-jyixok4n]:hover,.menu-link[data-astro-cid-jyixok4n]:focus{background:#000}.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n]{position:relative;display:block}.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n],.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n]:before,.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n]:after{background-color:#fff;width:100%;height:.2em}.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n]:before,.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n]:after{position:absolute;margin-top:-.6em;content:" "}.menu-link[data-astro-cid-jyixok4n] span[data-astro-cid-jyixok4n]:after{margin-top:.6em}@media(min-width:48em){.menu-link[data-astro-cid-jyixok4n]{left:150px;display:none}}#layout.active .menu-link[data-astro-cid-jyixok4n]{left:150px}#layout[data-astro-cid-jwirc66j]{position:relative;left:0;padding-left:0;transition:all .2s ease-out}#main[data-astro-cid-jwirc66j]{min-height:100vh}.content[data-astro-cid-jwirc66j]{margin:0 auto 50px;padding:80px 2em 0;max-width:800px;line-height:1.6em}@media(min-width:48em){#layout[data-astro-cid-jwirc66j]{padding-left:150px;left:0}.content[data-astro-cid-jwirc66j]{padding-left:2em;padding-right:2em}}@media(max-width:48em){#layout.active{position:relative;left:150px}} diff --git a/docs/_astro/index.DViPM5fQ.css b/docs/_astro/index.DViPM5fQ.css new file mode 100644 index 0000000..6e252ef --- /dev/null +++ b/docs/_astro/index.DViPM5fQ.css @@ -0,0 +1 @@ +/*! tailwindcss v4.1.18 | MIT License | https://tailwindcss.com */@layer properties{@supports (((-webkit-hyphens:none)) and (not (margin-trim:inline))) or ((-moz-orient:inline) and (not (color:rgb(from red r g b)))){*,:before,:after,::backdrop{--tw-translate-x:0;--tw-translate-y:0;--tw-translate-z:0;--tw-rotate-x:initial;--tw-rotate-y:initial;--tw-rotate-z:initial;--tw-skew-x:initial;--tw-skew-y:initial;--tw-space-y-reverse:0;--tw-border-style:solid;--tw-gradient-position:initial;--tw-gradient-from:#0000;--tw-gradient-via:#0000;--tw-gradient-to:#0000;--tw-gradient-stops:initial;--tw-gradient-via-stops:initial;--tw-gradient-from-position:0%;--tw-gradient-via-position:50%;--tw-gradient-to-position:100%;--tw-leading:initial;--tw-font-weight:initial;--tw-tracking:initial;--tw-shadow:0 0 #0000;--tw-shadow-color:initial;--tw-shadow-alpha:100%;--tw-inset-shadow:0 0 #0000;--tw-inset-shadow-color:initial;--tw-inset-shadow-alpha:100%;--tw-ring-color:initial;--tw-ring-shadow:0 0 #0000;--tw-inset-ring-color:initial;--tw-inset-ring-shadow:0 0 #0000;--tw-ring-inset:initial;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-offset-shadow:0 0 #0000;--tw-duration:initial;--tw-blur:initial;--tw-brightness:initial;--tw-contrast:initial;--tw-grayscale:initial;--tw-hue-rotate:initial;--tw-invert:initial;--tw-opacity:initial;--tw-saturate:initial;--tw-sepia:initial;--tw-drop-shadow:initial;--tw-drop-shadow-color:initial;--tw-drop-shadow-alpha:100%;--tw-drop-shadow-size:initial}}}@layer theme{:root,:host{--font-sans:"DM Sans",system-ui,sans-serif;--font-mono:"JetBrains Mono","SF Mono",Consolas,monospace;--color-black:#000;--color-white:#fff;--spacing:.25rem;--container-2xl:42rem;--container-3xl:48rem;--container-4xl:56rem;--container-6xl:72rem;--text-xs:.75rem;--text-xs--line-height:calc(1/.75);--text-sm:.875rem;--text-sm--line-height:calc(1.25/.875);--text-lg:1.125rem;--text-lg--line-height:calc(1.75/1.125);--text-xl:1.25rem;--text-xl--line-height:calc(1.75/1.25);--text-3xl:1.875rem;--text-3xl--line-height: 1.2 ;--text-4xl:2.25rem;--text-4xl--line-height:calc(2.5/2.25);--font-weight-semibold:600;--font-weight-bold:700;--tracking-tight:-.025em;--tracking-wider:.05em;--radius-lg:.5rem;--radius-2xl:1rem;--shadow-md:0 4px 12px #00000014;--default-transition-duration:.15s;--default-transition-timing-function:cubic-bezier(.4,0,.2,1);--default-font-family:var(--font-sans);--default-mono-font-family:var(--font-mono);--color-accent:#1f8dd6;--color-accent-light:#4da6e8;--color-accent-muted:#1f8dd626;--color-text-primary:#0a0a0a;--color-text-secondary:#525252;--color-text-muted:#737373;--color-bg-primary:#fafafa;--color-bg-secondary:#f5f5f5;--color-bg-code:#f0f0f0;--color-bg-code-inline:#0000000f;--color-border:#e5e5e5;--color-border-strong:#d4d4d4;--color-dark-text-primary:#fafafa;--color-dark-text-secondary:#a3a3a3;--color-dark-text-muted:#737373;--color-dark-bg-primary:#0a0a0a;--color-dark-bg-secondary:#141414;--color-dark-bg-code:#1a1a1a;--color-dark-bg-code-inline:#ffffff1a;--color-dark-border:#262626;--color-dark-border-strong:#404040;--color-dark-accent-muted:#1f8dd633;--font-display:"Bricolage Grotesque",system-ui,sans-serif;--header-height:4rem;--sidebar-width:260px;--content-max-width:800px;--section-padding-x:2rem;--transition-fast:.15s cubic-bezier(.4,0,.2,1);--transition-base:.25s cubic-bezier(.4,0,.2,1)}}@layer base{*,:after,:before,::backdrop{box-sizing:border-box;border:0 solid;margin:0;padding:0}::file-selector-button{box-sizing:border-box;border:0 solid;margin:0;padding:0}html,:host{-webkit-text-size-adjust:100%;tab-size:4;line-height:1.5;font-family:var(--default-font-family,ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji");font-feature-settings:var(--default-font-feature-settings,normal);font-variation-settings:var(--default-font-variation-settings,normal);-webkit-tap-highlight-color:transparent}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;-webkit-text-decoration:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-family:var(--default-mono-font-family,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace);font-feature-settings:var(--default-mono-font-feature-settings,normal);font-variation-settings:var(--default-mono-font-variation-settings,normal);font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}:-moz-focusring{outline:auto}progress{vertical-align:baseline}summary{display:list-item}ol,ul,menu{list-style:none}img,svg,video,canvas,audio,iframe,embed,object{vertical-align:middle;display:block}img,video{max-width:100%;height:auto}button,input,select,optgroup,textarea{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}::file-selector-button{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}:where(select:is([multiple],[size])) optgroup{font-weight:bolder}:where(select:is([multiple],[size])) optgroup option{padding-inline-start:20px}::file-selector-button{margin-inline-end:4px}::placeholder{opacity:1}@supports (not ((-webkit-appearance:-apple-pay-button))) or (contain-intrinsic-size:1px){::placeholder{color:currentColor}@supports (color:color-mix(in lab,red,red)){::placeholder{color:color-mix(in oklab,currentcolor 50%,transparent)}}}textarea{resize:vertical}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-date-and-time-value{min-height:1lh;text-align:inherit}::-webkit-datetime-edit{display:inline-flex}::-webkit-datetime-edit-fields-wrapper{padding:0}::-webkit-datetime-edit{padding-block:0}::-webkit-datetime-edit-year-field{padding-block:0}::-webkit-datetime-edit-month-field{padding-block:0}::-webkit-datetime-edit-day-field{padding-block:0}::-webkit-datetime-edit-hour-field{padding-block:0}::-webkit-datetime-edit-minute-field{padding-block:0}::-webkit-datetime-edit-second-field{padding-block:0}::-webkit-datetime-edit-millisecond-field{padding-block:0}::-webkit-datetime-edit-meridiem-field{padding-block:0}::-webkit-calendar-picker-indicator{line-height:1}:-moz-ui-invalid{box-shadow:none}button,input:where([type=button],[type=reset],[type=submit]){appearance:button}::file-selector-button{appearance:button}::-webkit-inner-spin-button{height:auto}::-webkit-outer-spin-button{height:auto}[hidden]:where(:not([hidden=until-found])){display:none!important}html{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;height:100%}body{font-family:var(--font-sans);color:var(--color-text-primary);background-color:var(--color-bg-primary);font-size:16px;font-weight:400;line-height:1.7;overflow-x:hidden}.dark body{color:var(--color-dark-text-primary);background-color:var(--color-dark-bg-primary)}h1,h2,h3,h4,h5,h6{font-family:var(--font-display);color:var(--color-text-primary);letter-spacing:-.02em;font-weight:700;line-height:1.2}.dark h1,.dark h2,.dark h3,.dark h4,.dark h5,.dark h6{color:var(--color-dark-text-primary)}h1{letter-spacing:-.03em;font-size:clamp(2.5rem,6vw,4.5rem);font-weight:800}h2{margin-top:3rem;margin-bottom:1.5rem;font-size:clamp(1.75rem,4vw,2.5rem)}h3{margin-top:2rem;margin-bottom:1rem;font-size:clamp(1.25rem,2vw,1.5rem)}p{margin-bottom:1.25rem}a{color:var(--color-accent);transition:color var(--transition-fast);word-break:break-word;text-decoration:none}a:hover{color:var(--color-accent-light)}code{font-family:var(--font-mono);background-color:var(--color-bg-code-inline);border-radius:4px;padding:.2em .4em;font-size:.875em}.dark code{background-color:var(--color-dark-bg-code-inline)}pre{font-family:var(--font-mono);background-color:var(--color-bg-code);border-radius:8px;padding:1.25rem;line-height:1.6;overflow-x:auto}.dark pre{background-color:var(--color-dark-bg-code)}pre>code{padding:0;font-size:.875rem;background-color:#0000!important}ul,ol{margin-bottom:1.25rem;padding-left:1.5rem}ul{list-style-type:disc}ol{list-style-type:decimal}li{margin-bottom:.5rem}ol ol,ul ol,ul ul ol,ul ol ol,ol ul ol,ol ol ol{list-style-type:decimal}blockquote{border-left:3px solid var(--color-accent);color:var(--color-text-secondary);margin:1.5rem 0;padding-left:1.5rem;font-style:italic}.dark blockquote{color:var(--color-dark-text-secondary)}strong{font-weight:600}::selection{background-color:var(--color-accent-muted);color:var(--color-text-primary)}.dark ::selection{background-color:var(--color-dark-accent-muted);color:var(--color-dark-text-primary)}:focus-visible{outline:2px solid var(--color-accent);outline-offset:2px}}@layer components{.glass{-webkit-backdrop-filter:blur(12px);background:#fafafad9}.dark .glass{background:#0a0a0ad9}.gradient-text{background:linear-gradient(135deg,var(--color-text-primary)0%,var(--color-accent)100%);-webkit-text-fill-color:transparent;-webkit-background-clip:text;background-clip:text}.dark .gradient-text{background:linear-gradient(135deg,var(--color-dark-text-primary)0%,var(--color-accent-light)100%);-webkit-text-fill-color:transparent;-webkit-background-clip:text;background-clip:text}.section-container{max-width:calc(var(--content-max-width) + var(--sidebar-width) + 4rem);padding:0 var(--section-padding-x);margin:0 auto}.prose-spec{max-width:var(--content-max-width)}.prose-spec h2{border-bottom:1px solid var(--color-border);margin-top:4rem;padding-bottom:.75rem}.dark .prose-spec h2{border-bottom-color:var(--color-dark-border)}.prose-spec h3{color:var(--color-text-secondary)}.dark .prose-spec h3{color:var(--color-dark-text-secondary)}.prose-spec img{border-radius:8px;max-width:100%;height:auto;margin:2rem 0}.border-subtle{border-color:var(--color-border)}.dark .border-subtle{border-color:var(--color-dark-border)}.btn{font-family:var(--font-sans);transition:all var(--transition-fast);cursor:pointer;border-radius:8px;justify-content:center;align-items:center;gap:.5rem;padding:.625rem 1.25rem;font-size:.875rem;font-weight:500;display:inline-flex}.btn-primary{background-color:var(--color-accent);color:#fff}.btn-primary:hover{background-color:var(--color-accent-light);box-shadow:var(--shadow-md);transform:translateY(-1px)}.btn-ghost{color:var(--color-text-secondary);background-color:#0000}.btn-ghost:hover{background-color:var(--color-bg-secondary);color:var(--color-text-primary)}.dark .btn-ghost{color:var(--color-dark-text-secondary)}.dark .btn-ghost:hover{background-color:var(--color-dark-bg-secondary);color:var(--color-dark-text-primary)}.sidebar-link{color:var(--color-text-muted);transition:all var(--transition-fast);border-left:2px solid #0000;border-radius:6px;margin-left:-2px;padding:.5rem 1rem;font-size:.875rem;display:block}.sidebar-link:hover{color:var(--color-text-primary);background-color:var(--color-bg-secondary)}.dark .sidebar-link{color:var(--color-dark-text-muted)}.dark .sidebar-link:hover{color:var(--color-dark-text-primary);background-color:var(--color-dark-bg-secondary)}.sidebar-link.active{color:var(--color-accent);border-left-color:var(--color-accent);background-color:var(--color-accent-muted)}.dark .sidebar-link.active{color:var(--color-accent-light);background-color:var(--color-dark-accent-muted)}.sidebar-link-sub{padding-left:1.5rem;font-size:.8125rem}.version-badge{font-family:var(--font-mono);background-color:var(--color-bg-secondary);border:1px solid var(--color-border);color:var(--color-text-muted);border-radius:9999px;align-items:center;padding:.25rem .75rem;font-size:.75rem;font-weight:500;display:inline-flex}.dark .version-badge{background-color:var(--color-dark-bg-secondary);border-color:var(--color-dark-border);color:var(--color-dark-text-muted)}.faq-item{border-bottom:1px solid var(--color-border)}.dark .faq-item{border-bottom-color:var(--color-dark-border)}.faq-question{text-align:left;width:100%;font-family:var(--font-display);color:var(--color-text-primary);cursor:pointer;transition:color var(--transition-fast);justify-content:space-between;align-items:center;padding:1.5rem 0;font-size:1.125rem;font-weight:600;display:flex}.dark .faq-question{color:var(--color-dark-text-primary)}.faq-question:hover{color:var(--color-accent)}.faq-answer{color:var(--color-text-secondary);padding-bottom:1.5rem}.dark .faq-answer{color:var(--color-dark-text-secondary)}#layout,#menu,.menu-link{transition:all var(--transition-base)}}@layer utilities{.pointer-events-none{pointer-events:none}.visible{visibility:visible}.absolute{position:absolute}.fixed{position:fixed}.relative{position:relative}.static{position:static}.inset-0{inset:calc(var(--spacing)*0)}.inset-x-0{inset-inline:calc(var(--spacing)*0)}.top-0{top:calc(var(--spacing)*0)}.top-1\/2{top:50%}.right-2{right:calc(var(--spacing)*2)}.right-6{right:calc(var(--spacing)*6)}.bottom-0{bottom:calc(var(--spacing)*0)}.bottom-6{bottom:calc(var(--spacing)*6)}.bottom-8{bottom:calc(var(--spacing)*8)}.left-1\/2{left:50%}.z-10{z-index:10}.z-40{z-index:40}.z-50{z-index:50}.mx-auto{margin-inline:auto}.mt-2{margin-top:calc(var(--spacing)*2)}.mt-8{margin-top:calc(var(--spacing)*8)}.mb-2{margin-bottom:calc(var(--spacing)*2)}.mb-3{margin-bottom:calc(var(--spacing)*3)}.mb-4{margin-bottom:calc(var(--spacing)*4)}.mb-6{margin-bottom:calc(var(--spacing)*6)}.mb-8{margin-bottom:calc(var(--spacing)*8)}.mb-10{margin-bottom:calc(var(--spacing)*10)}.mb-12{margin-bottom:calc(var(--spacing)*12)}.mb-16{margin-bottom:calc(var(--spacing)*16)}.block{display:block}.contents{display:contents}.flex{display:flex}.grid{display:grid}.hidden{display:none}.inline{display:inline}.inline-block{display:inline-block}.table{display:table}.h-4{height:calc(var(--spacing)*4)}.h-5{height:calc(var(--spacing)*5)}.h-6{height:calc(var(--spacing)*6)}.h-12{height:calc(var(--spacing)*12)}.h-16{height:calc(var(--spacing)*16)}.h-auto{height:auto}.max-h-\[70vh\]{max-height:70vh}.min-h-\[75vh\]{min-height:75vh}.min-h-screen{min-height:100vh}.w-4{width:calc(var(--spacing)*4)}.w-5{width:calc(var(--spacing)*5)}.w-6{width:calc(var(--spacing)*6)}.w-12{width:calc(var(--spacing)*12)}.w-full{width:100%}.max-w-2xl{max-width:var(--container-2xl)}.max-w-3xl{max-width:var(--container-3xl)}.max-w-4xl{max-width:var(--container-4xl)}.max-w-6xl{max-width:var(--container-6xl)}.min-w-0{min-width:calc(var(--spacing)*0)}.flex-1{flex:1}.flex-shrink-0{flex-shrink:0}.-translate-x-1\/2{--tw-translate-x: -50% ;translate:var(--tw-translate-x)var(--tw-translate-y)}.-translate-y-1\/2{--tw-translate-y: -50% ;translate:var(--tw-translate-x)var(--tw-translate-y)}.translate-y-\[-100\%\]{--tw-translate-y:-100%;translate:var(--tw-translate-x)var(--tw-translate-y)}.rotate-180{rotate:180deg}.transform{transform:var(--tw-rotate-x,)var(--tw-rotate-y,)var(--tw-rotate-z,)var(--tw-skew-x,)var(--tw-skew-y,)}.cursor-pointer{cursor:pointer}.appearance-none{appearance:none}.flex-col{flex-direction:column}.flex-wrap{flex-wrap:wrap}.items-center{align-items:center}.justify-between{justify-content:space-between}.justify-center{justify-content:center}.gap-1{gap:calc(var(--spacing)*1)}.gap-2{gap:calc(var(--spacing)*2)}.gap-3{gap:calc(var(--spacing)*3)}.gap-4{gap:calc(var(--spacing)*4)}.gap-8{gap:calc(var(--spacing)*8)}:where(.space-y-0>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*0)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*0)*calc(1 - var(--tw-space-y-reverse)))}:where(.space-y-1>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*1)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*1)*calc(1 - var(--tw-space-y-reverse)))}.overflow-hidden{overflow:hidden}.overflow-y-auto{overflow-y:auto}.rounded-2xl{border-radius:var(--radius-2xl)}.rounded-full{border-radius:3.40282e38px}.rounded-lg{border-radius:var(--radius-lg)}.rounded-t-2xl{border-top-left-radius:var(--radius-2xl);border-top-right-radius:var(--radius-2xl)}.border{border-style:var(--tw-border-style);border-width:1px}.border-t{border-top-style:var(--tw-border-style);border-top-width:1px}.border-b{border-bottom-style:var(--tw-border-style);border-bottom-width:1px}.border-\[var\(--color-border\)\]{border-color:var(--color-border)}.border-transparent{border-color:#0000}.bg-\[var\(--color-accent\)\]{background-color:var(--color-accent)}.bg-\[var\(--color-bg-primary\)\]{background-color:var(--color-bg-primary)}.bg-black\/50{background-color:#00000080}@supports (color:color-mix(in lab,red,red)){.bg-black\/50{background-color:color-mix(in oklab,var(--color-black)50%,transparent)}}.bg-transparent{background-color:#0000}.bg-white{background-color:var(--color-white)}.bg-gradient-to-b{--tw-gradient-position:to bottom in oklab;background-image:linear-gradient(var(--tw-gradient-stops))}.from-\[var\(--color-bg-secondary\)\]{--tw-gradient-from:var(--color-bg-secondary);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.to-\[var\(--color-bg-primary\)\]{--tw-gradient-to:var(--color-bg-primary);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.p-2{padding:calc(var(--spacing)*2)}.p-4{padding:calc(var(--spacing)*4)}.p-6{padding:calc(var(--spacing)*6)}.p-8{padding:calc(var(--spacing)*8)}.px-3{padding-inline:calc(var(--spacing)*3)}.px-4{padding-inline:calc(var(--spacing)*4)}.px-6{padding-inline:calc(var(--spacing)*6)}.py-1\.5{padding-block:calc(var(--spacing)*1.5)}.py-2{padding-block:calc(var(--spacing)*2)}.py-3{padding-block:calc(var(--spacing)*3)}.py-4{padding-block:calc(var(--spacing)*4)}.py-8{padding-block:calc(var(--spacing)*8)}.py-16{padding-block:calc(var(--spacing)*16)}.py-20{padding-block:calc(var(--spacing)*20)}.pt-8{padding-top:calc(var(--spacing)*8)}.pr-4{padding-right:calc(var(--spacing)*4)}.pr-8{padding-right:calc(var(--spacing)*8)}.text-center{text-align:center}.font-display{font-family:var(--font-display)}.font-mono{font-family:var(--font-mono)}.text-3xl{font-size:var(--text-3xl);line-height:var(--tw-leading,var(--text-3xl--line-height))}.text-lg{font-size:var(--text-lg);line-height:var(--tw-leading,var(--text-lg--line-height))}.text-sm{font-size:var(--text-sm);line-height:var(--tw-leading,var(--text-sm--line-height))}.text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.text-xs{font-size:var(--text-xs);line-height:var(--tw-leading,var(--text-xs--line-height))}.text-\[8rem\]{font-size:8rem}.leading-none{--tw-leading:1;line-height:1}.font-bold{--tw-font-weight:var(--font-weight-bold);font-weight:var(--font-weight-bold)}.font-semibold{--tw-font-weight:var(--font-weight-semibold);font-weight:var(--font-weight-semibold)}.tracking-tight{--tw-tracking:var(--tracking-tight);letter-spacing:var(--tracking-tight)}.tracking-wider{--tw-tracking:var(--tracking-wider);letter-spacing:var(--tracking-wider)}.text-\[var\(--color-border-strong\)\]{color:var(--color-border-strong)}.text-\[var\(--color-text-muted\)\]{color:var(--color-text-muted)}.text-\[var\(--color-text-primary\)\]{color:var(--color-text-primary)}.text-\[var\(--color-text-secondary\)\]{color:var(--color-text-secondary)}.text-white{color:var(--color-white)}.uppercase{text-transform:uppercase}.no-underline{text-decoration-line:none}.opacity-\[0\.03\]{opacity:.03}.shadow-lg{--tw-shadow:0 8px 30px var(--tw-shadow-color,#0000001f);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.shadow-xl{--tw-shadow:0 20px 25px -5px var(--tw-shadow-color,#0000001a),0 8px 10px -6px var(--tw-shadow-color,#0000001a);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.transition{transition-property:color,background-color,border-color,outline-color,text-decoration-color,fill,stroke,--tw-gradient-from,--tw-gradient-via,--tw-gradient-to,opacity,box-shadow,transform,translate,scale,rotate,filter,-webkit-backdrop-filter,backdrop-filter,display,content-visibility,overlay,pointer-events;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-all{transition-property:all;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-colors{transition-property:color,background-color,border-color,outline-color,text-decoration-color,fill,stroke,--tw-gradient-from,--tw-gradient-via,--tw-gradient-to;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.transition-transform{transition-property:transform,translate,scale,rotate;transition-timing-function:var(--tw-ease,var(--default-transition-timing-function));transition-duration:var(--tw-duration,var(--default-transition-duration))}.delay-100{transition-delay:.1s}.delay-200{transition-delay:.2s}.delay-300{transition-delay:.3s}.delay-400{transition-delay:.4s}.delay-700{transition-delay:.7s}.duration-200{--tw-duration:.2s;transition-duration:.2s}.duration-300{--tw-duration:.3s;transition-duration:.3s}@media(hover:hover){.hover\:border-\[var\(--color-accent\)\]:hover{border-color:var(--color-accent)}.hover\:bg-\[var\(--color-accent-light\)\]:hover{background-color:var(--color-accent-light)}.hover\:bg-\[var\(--color-bg-secondary\)\]:hover{background-color:var(--color-bg-secondary)}.hover\:bg-white\/50:hover{background-color:#ffffff80}@supports (color:color-mix(in lab,red,red)){.hover\:bg-white\/50:hover{background-color:color-mix(in oklab,var(--color-white)50%,transparent)}}.hover\:text-\[var\(--color-accent\)\]:hover{color:var(--color-accent)}.hover\:text-\[var\(--color-text-primary\)\]:hover{color:var(--color-text-primary)}}.focus\:border-\[var\(--color-accent\)\]:focus{border-color:var(--color-accent)}.focus\:outline-none:focus{--tw-outline-style:none;outline-style:none}@media(min-width:40rem){.sm\:grid-cols-2{grid-template-columns:repeat(2,minmax(0,1fr))}.sm\:p-8{padding:calc(var(--spacing)*8)}.sm\:px-6{padding-inline:calc(var(--spacing)*6)}.sm\:py-28{padding-block:calc(var(--spacing)*28)}.sm\:text-4xl{font-size:var(--text-4xl);line-height:var(--tw-leading,var(--text-4xl--line-height))}.sm\:text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.sm\:text-\[12rem\]{font-size:12rem}}@media(min-width:48rem){.md\:flex{display:flex}.md\:hidden{display:none}}@media(min-width:64rem){.lg\:sticky{position:sticky}.lg\:top-24{top:calc(var(--spacing)*24)}.lg\:mr-8{margin-right:calc(var(--spacing)*8)}.lg\:block{display:block}.lg\:flex{display:flex}.lg\:hidden{display:none}.lg\:max-h-\[calc\(100vh-8rem\)\]{max-height:calc(100vh - 8rem)}.lg\:w-64{width:calc(var(--spacing)*64)}.lg\:flex-shrink-0{flex-shrink:0}.lg\:gap-8{gap:calc(var(--spacing)*8)}.lg\:self-start{align-self:flex-start}.lg\:overflow-y-auto{overflow-y:auto}.lg\:border-r{border-right-style:var(--tw-border-style);border-right-width:1px}.lg\:pr-8{padding-right:calc(var(--spacing)*8)}}@media(prefers-color-scheme:dark){.dark\:border-\[var\(--color-dark-border\)\]{border-color:var(--color-dark-border)}.dark\:bg-\[var\(--color-dark-bg-primary\)\]{background-color:var(--color-dark-bg-primary)}.dark\:bg-\[var\(--color-dark-bg-secondary\)\]{background-color:var(--color-dark-bg-secondary)}.dark\:from-\[var\(--color-dark-bg-secondary\)\]{--tw-gradient-from:var(--color-dark-bg-secondary);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.dark\:to-\[var\(--color-dark-bg-primary\)\]{--tw-gradient-to:var(--color-dark-bg-primary);--tw-gradient-stops:var(--tw-gradient-via-stops,var(--tw-gradient-position),var(--tw-gradient-from)var(--tw-gradient-from-position),var(--tw-gradient-to)var(--tw-gradient-to-position))}.dark\:text-\[var\(--color-dark-border-strong\)\]{color:var(--color-dark-border-strong)}.dark\:text-\[var\(--color-dark-text-muted\)\]{color:var(--color-dark-text-muted)}.dark\:text-\[var\(--color-dark-text-primary\)\]{color:var(--color-dark-text-primary)}.dark\:text-\[var\(--color-dark-text-secondary\)\]{color:var(--color-dark-text-secondary)}.dark\:opacity-\[0\.05\]{opacity:.05}.dark\:shadow-none{--tw-shadow:0 0 #0000;box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}.dark\:contrast-90{--tw-contrast:contrast(90%);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.dark\:hue-rotate-180{--tw-hue-rotate:hue-rotate(180deg);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}.dark\:invert{--tw-invert:invert(100%);filter:var(--tw-blur,)var(--tw-brightness,)var(--tw-contrast,)var(--tw-grayscale,)var(--tw-hue-rotate,)var(--tw-invert,)var(--tw-saturate,)var(--tw-sepia,)var(--tw-drop-shadow,)}@media(hover:hover){.dark\:hover\:bg-\[var\(--color-dark-bg-secondary\)\]:hover{background-color:var(--color-dark-bg-secondary)}.dark\:hover\:bg-white\/10:hover{background-color:#ffffff1a}@supports (color:color-mix(in lab,red,red)){.dark\:hover\:bg-white\/10:hover{background-color:color-mix(in oklab,var(--color-white)10%,transparent)}}.dark\:hover\:text-\[var\(--color-dark-text-primary\)\]:hover{color:var(--color-dark-text-primary)}}}}html{scroll-behavior:smooth}[id]{scroll-margin-top:calc(var(--header-height) + 2rem)}@keyframes fade-in{0%{opacity:0}to{opacity:1}}@keyframes fade-in-up{0%{opacity:0;transform:translateY(20px)}to{opacity:1;transform:translateY(0)}}@keyframes fade-in-down{0%{opacity:0;transform:translateY(-10px)}to{opacity:1;transform:translateY(0)}}@keyframes slide-in-left{0%{opacity:0;transform:translate(-20px)}to{opacity:1;transform:translate(0)}}@keyframes bounce-subtle{0%,to{transform:translateY(0)}50%{transform:translateY(-8px)}}.animate-fade-in{opacity:0;animation:.4s ease-out forwards fade-in}.animate-fade-in-up{opacity:0;animation:.6s cubic-bezier(.16,1,.3,1) forwards fade-in-up}.animate-fade-in-down{opacity:0;animation:.25s ease-out forwards fade-in-down}.animate-slide-in-left{opacity:0;animation:.6s cubic-bezier(.16,1,.3,1) forwards slide-in-left}.animate-bounce-subtle{animation:2s ease-in-out infinite bounce-subtle}.delay-100{animation-delay:.1s}.delay-200{animation-delay:.2s}.delay-300{animation-delay:.3s}.delay-400{animation-delay:.4s}.delay-500{animation-delay:.5s}.delay-600{animation-delay:.6s}.delay-700{animation-delay:.7s}.delay-800{animation-delay:.8s}@property --tw-translate-x{syntax:"*";inherits:false;initial-value:0}@property --tw-translate-y{syntax:"*";inherits:false;initial-value:0}@property --tw-translate-z{syntax:"*";inherits:false;initial-value:0}@property --tw-rotate-x{syntax:"*";inherits:false}@property --tw-rotate-y{syntax:"*";inherits:false}@property --tw-rotate-z{syntax:"*";inherits:false}@property --tw-skew-x{syntax:"*";inherits:false}@property --tw-skew-y{syntax:"*";inherits:false}@property --tw-space-y-reverse{syntax:"*";inherits:false;initial-value:0}@property --tw-border-style{syntax:"*";inherits:false;initial-value:solid}@property --tw-gradient-position{syntax:"*";inherits:false}@property --tw-gradient-from{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-via{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-to{syntax:"";inherits:false;initial-value:#0000}@property --tw-gradient-stops{syntax:"*";inherits:false}@property --tw-gradient-via-stops{syntax:"*";inherits:false}@property --tw-gradient-from-position{syntax:"";inherits:false;initial-value:0%}@property --tw-gradient-via-position{syntax:"";inherits:false;initial-value:50%}@property --tw-gradient-to-position{syntax:"";inherits:false;initial-value:100%}@property --tw-leading{syntax:"*";inherits:false}@property --tw-font-weight{syntax:"*";inherits:false}@property --tw-tracking{syntax:"*";inherits:false}@property --tw-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-shadow-color{syntax:"*";inherits:false}@property --tw-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-inset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-shadow-color{syntax:"*";inherits:false}@property --tw-inset-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-ring-color{syntax:"*";inherits:false}@property --tw-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-ring-color{syntax:"*";inherits:false}@property --tw-inset-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-ring-inset{syntax:"*";inherits:false}@property --tw-ring-offset-width{syntax:"";inherits:false;initial-value:0}@property --tw-ring-offset-color{syntax:"*";inherits:false;initial-value:#fff}@property --tw-ring-offset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-duration{syntax:"*";inherits:false}@property --tw-blur{syntax:"*";inherits:false}@property --tw-brightness{syntax:"*";inherits:false}@property --tw-contrast{syntax:"*";inherits:false}@property --tw-grayscale{syntax:"*";inherits:false}@property --tw-hue-rotate{syntax:"*";inherits:false}@property --tw-invert{syntax:"*";inherits:false}@property --tw-opacity{syntax:"*";inherits:false}@property --tw-saturate{syntax:"*";inherits:false}@property --tw-sepia{syntax:"*";inherits:false}@property --tw-drop-shadow{syntax:"*";inherits:false}@property --tw-drop-shadow-color{syntax:"*";inherits:false}@property --tw-drop-shadow-alpha{syntax:"";inherits:false;initial-value:100%}@property --tw-drop-shadow-size{syntax:"*";inherits:false} diff --git a/docs/index.html b/docs/index.html index 2947b2d..b56bfb1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1 +1,504 @@ -Redirecting to: /spec/1.0.0-rc.5 Redirecting from / to /spec/1.0.0-rc.5 \ No newline at end of file + Git Common-Flow 1.0.0-rc.5 +
+Git Common-Flow +

+Git Common-Flow +

+A sensible git workflow for teams who ship +

v1.0.0-rc.5
Git Common-Flow diagram

About Common-Flow

+A practical git workflow that combines the best of GitHub Flow with + versioned releases +

Common-Flow is an attempt to gather a sensible selection of the most common +usage patterns of git into a single and concise specification. It is based on +the original variant +of GitHub Flow, while taking +into account how a lot of open source projects most commonly use git.

+

In short, Common-Flow is essentially GitHub Flow with the addition of versioned +releases, optional release branches, and without the requirement to deploy to +production all the time.

+Key Principles +

    +
  • The "master" branch is the mainline branch with latest changes, and must not +be broken.
    • +
  • Changes (features, bugfixes, etc.) are done on "change branches" created from +the master branch.
    • +
  • Rebase change branches early and often.
    • +
  • When a change branch is stable and ready, it is merged back in to master.
    • +
  • A release is just a git tag who's name is the exact release version string +(e.g. "2.11.4").
    • +
  • Release branches can be used to avoid change freezes on master. They are not +required, instead they are available if you need them.
    • +

+Author +

The Git Common-Flow specification is authored +by Jim Myhrberg.

+

If you'd like to leave feedback, +please open an issue on GitHub.

The Specification

+The complete Git Common-Flow specification +

Terminology

    +
  • Master Branch - Must be named "master", must always have passing tests, +and is not guaranteed to always work in production environments.
    • +
  • Change Branches - Any branch that introduces changes like a new feature, a +bug fix, etc.
    • +
  • Source Branch - The branch that a change branch was created from. New +changes in the source branch should be incorporated into the change branch via +rebasing.
    • +
  • Merge Target - A branch that is the intended merge target for a change +branch. Typically the merge target branch will be the same as the source +branch.
    • +
  • Pull Request - A means of requesting that a change branch is merged in to +its merge target, allowing others to review, discuss and approve the changes.
    • +
  • Release - May be considered safe to use in production environments. Is +effectively just a git tag named after the version of the release.
    • +
  • Release Branches - Used both for short-term preparations of a release, and +also for long-term maintenance of older version.
    • +

Git Common-Flow Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be +interpreted as described in RFC 2119.

+
    +
  1. TL;DR +
      +
    1. Do not break the master branch.
      2. +
    2. A release is a git tag.
      3. +
    +
    2. +
  2. The Master Branch +
      +
    1. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
      2. +
    2. The master branch MUST always be in a non-broken state with its test +suite passing.
      3. +
    3. The master branch IS NOT guaranteed to always work in production +environments. Despite test suites passing it may at times contain +unfinished work. Only releases may be considered safe for production use.
      4. +
    4. The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new +release.
      5. +
    +
    3. +
  3. Change Branches +
      +
    1. Each change (feature, bugfix, etc.) MUST be performed on separate +branches that SHOULD be referred to as "change branches".
      2. +
    2. All change branches MUST have descriptive names.
      3. +
    3. It is RECOMMENDED that you commit often locally, and that you try and +keep the commits reasonably structured to avoid a messy and confusing git +history.
      4. +
    4. You SHOULD regularly push your work to the same named branch on the +remote server.
      5. +
    5. You SHOULD create separate change branches for each distinctly different +change. You SHOULD NOT include multiple unrelated changes into a single +change branch.
      6. +
    6. When a change branch is created, the branch that it is created from +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target" branch, typically this will be the same +as the source branch.
      7. +
    7. Change branches MUST be regularly updated with any changes from their +source branch. This MUST be done by rebasing the change branch on top of +the source branch.
      8. +
    8. After updating a change branch from its source branch you MUST push the +change branch to the remote server. Due to the nature of rebasing, you +will be required to do a force push, and you MUST use the +"--force-with-lease" git push option when doing so instead of the regular +"--force".
      9. +
    9. If there is a truly valid technical reason to not use rebase when +updating change branches, then you can update change branches via merge +instead of rebase. The decision to use merge MUST only be taken after all +possible options to use rebase have been tried and failed. People not +understanding how to use rebase is NOT a valid reason to use merge. If +you do decide to use merge instead of rebase, you MUST NOT use a mixture +of both methods, pick one and stick to it.
      10. +
    +
    4. +
  4. Pull Requests +
      +
    1. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent).
      2. +
    2. The purpose of a pull request is to allow others to review your changes +and give feedback. You can then fix any issues, complaints, and more that +might arise, and then let people review again.
      3. +
    3. Before creating a pull request, it is RECOMMENDED that you consider the +state of your change branch's commit history. If it is messy and +confusing, it might be a good idea to rebase your branch with "git rebase +-i" to present a cleaner and easier to follow commit history for your +reviewers.
      4. +
    4. A pull request MUST only be merged when the change branch is up-to-date +with its source branch, the test suite is passing, and you and others are +happy with the change. This is especially important if the merge target +is the master branch.
      5. +
    5. To get feedback, help, or generally just discuss a change branch with +others, it is RECOMMENDED you create a pull request and discuss the +changes with others there. This leaves a clear and visible history of +how, when, and why the code looks and behaves the way it does.
      6. +
    +
    5. +
  5. Versioning +
      +
    1. A "version string" is a typically mostly numeric string that identifies a +specific version of a project. The version string itself MUST NOT have a +"v" prefix, but the version string can be displayed with a "v" prefix to +indicate it is a version that is being referred to.
      2. +
    2. The source of truth for a project's version MUST be a git tag with a name +based on the version string. This kind of tag MUST be referred to as a +"release tag".
      3. +
    3. It is OPTIONAL, but RECOMMENDED to also keep the version string +hard-coded somewhere in the project code-base.
      4. +
    4. If you hard-code the version string into the code-base, it is RECOMMENDED +that you do so in a file called "VERSION" located in the root of the +project. But be mindful of the conventions of your programming language +and community when choosing if, where and how to hard-code the version +string.
      5. +
    5. If you are using a "VERSION" file in the root of the project, this file +MUST only contain the exact version string, meaning it MUST NOT have a +"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
      6. +
    6. It is OPTIONAL, but RECOMMENDED that that the version string follows +Semantic Versioning (http://semver.org/).
      7. +
    +
    6. +
  6. Releases +
      +
    1. To create a new release, you MUST create a git tag named as the exact +version string of the release. This kind of tag MUST be referred to as a +"release tag".
      2. +
    2. The release tag name can OPTIONALLY be prefixed with "v". For example the +tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED +that you do not use a "v" prefix. You MUST NOT use a mixture of "v" +prefixed and non-prefixed tags. Pick one form and stick to it.
      3. +
    3. If the version string is hard-coded into the code-base, you MUST create a +"version bump" commit which changes the hard-coded version string of the +project.
      4. +
    4. When using version bump commits, the release tag MUST be placed on the +version bump commit.
      5. +
    5. If you are not using a release branch, then the release tag, and if +relevant the version bump commit, MUST be created directly on the master +branch.
      6. +
    6. The version bump commit SHOULD have a commit message title of "Bump +version to VERSION". For example, if the new version string is "2.11.4", +the first line of the commit message SHOULD read: "Bump version to +2.11.4"
      7. +
    7. It is RECOMMENDED that release tags are lightweight tags, but you can +OPTIONALLY use annotated tags if you want to include changelog +information in the release tag itself.
      8. +
    8. If you use annotated release tags, the first line of the annotation +SHOULD read "Release VERSION". For example for version "2.11.4" the first +line of the tag annotation SHOULD read "Release 2.11.4". The second line +MUST be blank, and the changelog MUST start on the third line.
      9. +
    +
    7. +
  7. Short-Term Release Branches +
      +
    1. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
      2. +
    2. Any release branch which has a name ending with a specific version +string, MUST be referred to as a "short-term release branch".
      3. +
    3. Use of short-term release branches are OPTIONAL, and intended to be used +to create a specific versioned release.
      4. +
    4. A short-term release branch is RECOMMENDED if there is a lengthy +pre-release verification process to avoid a code freeze on the master +branch.
      5. +
    5. Short-term release branches MUST have a name of "release-VERSION". For +example for version "2.11.4" the release branch name MUST be +"release-2.11.4".
      6. +
    6. When using a short-term release branch to create a release, the release +tag and if used, version bump commit, MUST be placed directly on the +short-term release branch itself.
      7. +
    7. Only very minor changes should be performed on a short-term release +branch directly. Any larger changes SHOULD be done in the master branch, +and SHOULD be pulled into the release branch by rebasing it on top of the +master branch the same way a change branch pulls in updates from its +source branch.
      8. +
    8. After a release tag has been created, the release branch MUST be merged +back into its source branch and then deleted. Typically the source branch +will be the master branch.
      9. +
    +
    8. +
  8. Long-term Release Branches +
      +
    1. Any release branch which has a name ending with a non-specific version +string, MUST be referred to as a "long-term release branch". For example +"release-2.11" is a long-term release branch, while "release-2.11.4" is a +short-term release branch.
      2. +
    2. Use of long-term release branches are OPTIONAL, and intended for work on +versions which are not currently part of the master branch. Typically +this is useful when you need to create a new maintenance release for a +older version.
      3. +
    3. A long-term release branch MUST have a name with a non-specific version +number. For example a long-term release branch for creating new 2.9.x +releases MUST be named "release-2.9".
      4. +
    4. Long-term release branches for maintenance releases of older versions +MUST be created from the relevant release tag. For example if the master +branch is on version 2.11.4 and there is a security fix for all 2.9.x +releases, the latest of which is "2.9.7". Create a new branch called +"release-2.9" from the "2.9.7" release tag. The security fix release will +then end up being version "2.9.8".
      5. +
    5. To create a new release from a long-term release branch, you MUST follow +the same process as a release from the master branch, except the +long-term release branch takes the place of the master branch.
      6. +
    6. A long-term release branch should be treated with the same respect as the +master branch. It is effectively the master branch for the release series +in question. Meaning it MUST always be in a non-broken state, MUST NOT be +force pushed to, etc.
      7. +
    +
    9. +
  9. Bug Fixes & Rollback +
      +
    1. You MUST NOT under any circumstances force push to the master branch or +to long-term release branches.
      2. +
    2. If a change branch which has been merged into the master branch is found +to have a bug in it, the bug fix work MUST be done as a new separate +change branch and MUST follow the same workflow as any other change +branch.
      3. +
    3. If a change branch is wrongfully merged into master, or for any other +reason the merge must be undone, you MUST undo the merge by reverting the +merge commit itself. Effectively creating a new commit that reverses all +the relevant changes.
      4. +
    +
    10. +
  10. Git Best Practices +
      +
    1. All commit messages SHOULD follow the Commit Guidelines and format from +the official git +documentation: +https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
      2. +
    2. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" or "git add -p" to add individual +changes to the staging area so you are fully aware of what you are +committing.
      3. +
    3. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More +information: +https://developer.atlassian.com/blog/2015/04/force-with-lease/
      4. +
    4. You SHOULD understand and be comfortable with +rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      5. +
    5. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
      6. +
    6. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +This makes sure the reference to the original branch is kept in the +commits, allows one to revert a merge by reverting a single merge commit, +and creates a merge commit to mark the integration of the branch with +master.
      7. +
    +
    11. +

FAQ

+Common questions about Git Common-Flow +

\ No newline at end of file diff --git a/docs/spec/1.0.0-rc.1/index.html b/docs/spec/1.0.0-rc.1/index.html index 94d8e5a..0ffd8f2 100644 --- a/docs/spec/1.0.0-rc.1/index.html +++ b/docs/spec/1.0.0-rc.1/index.html @@ -1,45 +1,169 @@ - Git Common-Flow 1.0.0-rc.1 | Git Common Flow -

Git Common-Flow 1.0.0-rc.1

-Git Common-Flow 1.0.0-rc.1 diagram -

Summary

-

Common-Flow is an attempt to gather a sensible selection of the most common + 12a4 4 0 11-8 0 4 4 0 018 0z">

+Git Common-Flow +

+A sensible git workflow for teams who ship +

v1.0.0-rc.1
Git Common-Flow diagram

About Common-Flow

+A practical git workflow that combines the best of GitHub Flow with + versioned releases +

+Key Principles +

Common-Flow is an attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification. It is based on the original variant of GitHub Flow, while taking into account how a lot of open source projects use git.

TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned releases, maintenance releases for old versions, and without the requirement to -deploy to production all the time.

-

Terminology

-
    +deploy to production all the time.

+Author +

The Git Common-Flow specification is authored +by Jim Myhrberg.

+

If you'd like to leave feedback, +please open an issue on GitHub.

The Specification

+The complete Git Common-Flow specification +

Terminology

  • Master Branch - Must always have passing tests, is considered bleeding edge, and must be named master.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -61,33 +185,31 @@ and a git tag named according to the new version string placed on said commit.Maintenance Release - Just like a regular release, except the version bump commit and release tag are on a maintenance branch instead of the master branch.
    • -
-

Git Common-Flow Specification (Common-Flow)

-

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, -“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be +

Git Common-Flow Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  1. The Master Branch
      -
    1. A branch named “master” MUST exist and it MUST be referred to as the -“master branch”.
      2. +
    2. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
    3. The master branch MUST be considered bleeding edge.
    4. The master branch MUST always be in a non-broken state with its test suite passing.
      5. -
    5. The master branch SHOULD always be in a “as near as possible ready for -release/production” state to reduce the friction of creating a new +
    6. The master branch SHOULD always be in a "as near as possible ready for +release/production" state to reduce the friction of creating a new release.
  2. Changes
    1. Changes MUST be performed on a separate branch that SHOULD be referred to -as a “change branch”. All change branches MUST have descriptive names. It +as a "change branch". All change branches MUST have descriptive names. It is RECOMMENDED that you commit often locally, and you SHOULD regularly push your work to the same named branch on the remote server.
    2. When a change branch is created, the branch that it is created from -SHOULD be referred to as the “source branch”. Each change branch also -needs a designated “merge target branch”, typically this will be the same +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target branch", typically this will be the same as the source branch.
    3. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of @@ -95,9 +217,9 @@ the source branch. To be clear you MUST NOT merge a source branch into a change branch.
    4. After rebasing a change branch on top of its source branch you MUST push the change branch to the remote server. This will require you do a force -push, and you SHOULD use the “—force-with-lease” git push option.
      5. +push, and you SHOULD use the "--force-with-lease" git push option.
    5. To merge a change branch into its merge target branch, you MUST open a -“pull request” (or equivalent) so others can review and approve your +"pull request" (or equivalent) so others can review and approve your changes.
    6. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are @@ -114,16 +236,16 @@ discuss the changes with others there.
      7. the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project -
    7. You SHOULD always use “—force-with-lease” when doing a force push. The -plain “—force” option is dangerous and destructive. More +
    8. You SHOULD always use "--force-with-lease" when doing a force push. The +plain "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
    9. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      10. -
    10. It is RECOMMENDED that you always do “git pull —rebase” instead of “git -pull” to avoid unnecessary merge commits. You can make this the default -behavior of “git pull” with “git config —global pull.rebase true”.
      11. -
    11. It is RECOMMENDED that all branches be merged using “git merge —no-ff”. +
    12. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
      13. +
    13. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with master.
      14. @@ -132,34 +254,34 @@ a merge commit to mark the integration of the branch with master.
    14. Versioning
      1. The project MUST have its version hard-coded somewhere in the -code-base. It is RECOMMENDED that this is done in a file called “VERSION” +code-base. It is RECOMMENDED that this is done in a file called "VERSION" located in the root of the project.
        2. -
      2. If you are using a “VERSION” file in the root of the project, this MUST +
      3. If you are using a "VERSION" file in the root of the project, this MUST only contain the exact version string.
      4. The version string SHOULD follow the Semantic Versioning (http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, -but the version string MUST NOT have a “v” prefix. For example “v2.11.4” -is bad, and “2.11.4” is good.
        5. +but the version string MUST NOT have a "v" prefix. For example "v2.11.4" +is bad, and "2.11.4" is good.
    15. Releases
        -
      1. To create a new release, you MUST create a “version bump” commit directly +
      2. To create a new release, you MUST create a "version bump" commit directly on the master branch which changes the hard-coded version value of the project. The version bump commit MUST have a git tag created on it and named as the exact version string.
        3. -
      3. A version bump commit MUST have a commit message title of “Bump version -to VERSION”. For example, if the new version string is “2.11.4”, the -first line of the commit message MUST read: “Bump version to 2.11.4”
        4. +
      4. A version bump commit MUST have a commit message title of "Bump version +to VERSION". For example, if the new version string is "2.11.4", the +first line of the commit message MUST read: "Bump version to 2.11.4"
      5. The release tag on the version bump commit MUST be named exactly the same as the version string. The tag name can OPTIONALLY be prefixed with -“v”. For example the tag name can be either “2.11.4” or “v2.11.4”.
        6. +"v". For example the tag name can be either "2.11.4" or "v2.11.4".
      6. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      7. If you use annotated release tags, the first line of the annotation MUST -read “Release VERSION”. For example for version “2.11.4” the first line -of the tag annotation would read “Release 2.11.4”. The second line must +read "Release VERSION". For example for version "2.11.4" the first line +of the tag annotation would read "Release 2.11.4". The second line must be blank, and the changelog MUST start on the third line.
      16. @@ -178,22 +300,22 @@ the relevant changes.
    16. Maintenance Releases
        -
      1. Any branch that has a name starting with “stable-” SHOULD be referred to -as a “maintenance branch”.
        2. +
      2. Any branch that has a name starting with "stable-" SHOULD be referred to +as a "maintenance branch".
      3. Maintenance branches are used for managing new releases of older versions. Typically this is used to provide security updates for older versions when the master branch has moved on to a point that a new release for the old version cannot be made from the master branch.
        4. -
      4. A “maintenance release” is identical to a regular release, except the +
      5. A "maintenance release" is identical to a regular release, except the version bump commit and the release tag are placed on the maintenance branch instead of on the master branch.
        6. -
      6. A maintenance branch SHOULD follow a “stable-X.Y” naming pattern, where -“X” is the MAJOR version and “Y” is the minor version.
        7. +
      7. A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where +"X" is the MAJOR version and "Y" is the minor version.
      8. A maintenance branch MUST be created from the relevant release tag. For example if there is a security fix for all 2.9.x releases, the latest of -which is “2.9.7”, we create a new branch called “stable-2.9” off of the -“2.9.7” release tag. The security fix release will then end up being -version “2.9.8”.
        9. +which is "2.9.7", we create a new branch called "stable-2.9" off of the +"2.9.7" release tag. The security fix release will then end up being +version "2.9.8".
      9. When working on a maintenance release, the relevant maintenance branch MUST be thought of as the master branch for that maintenance work.
      10. Changes in a maintenance branch SHOULD typically come from work being @@ -203,11 +325,17 @@ into the master branch, that work should have happened against the master branch in the first place.
      17. -
    -

    About

    -

    The Git Common-Flow specification is authored -by Jim Myhrberg.

    -

    If you’d like to leave feedback, -please open an issue on GitHub.

    -

    License

    -

    Creative Commons - CC BY 3.0

\ No newline at end of file +

FAQ

+Common questions about Git Common-Flow +

\ No newline at end of file diff --git a/docs/spec/1.0.0-rc.2/index.html b/docs/spec/1.0.0-rc.2/index.html index 45baf89..4bff37e 100644 --- a/docs/spec/1.0.0-rc.2/index.html +++ b/docs/spec/1.0.0-rc.2/index.html @@ -1,45 +1,169 @@ - Git Common-Flow 1.0.0-rc.2 | Git Common Flow -

Git Common-Flow 1.0.0-rc.2

-Git Common-Flow 1.0.0-rc.2 diagram -

Summary

-

Common-Flow is an attempt to gather a sensible selection of the most common + 12a4 4 0 11-8 0 4 4 0 018 0z">

+Git Common-Flow +

+A sensible git workflow for teams who ship +

v1.0.0-rc.2
Git Common-Flow diagram

About Common-Flow

+A practical git workflow that combines the best of GitHub Flow with + versioned releases +

+Key Principles +

Common-Flow is an attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification. It is based on the original variant of GitHub Flow, while taking into account how a lot of open source projects use git.

TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned releases, maintenance releases for old versions, and without the requirement to -deploy to production all the time.

-

Terminology

-
    +deploy to production all the time.

+Author +

The Git Common-Flow specification is authored +by Jim Myhrberg.

+

If you'd like to leave feedback, +please open an issue on GitHub.

The Specification

+The complete Git Common-Flow specification +

Terminology

  • Master Branch - Must always have passing tests, is considered bleeding edge, and must be named master.
  • Change Branches - Any branch that introduces changes like a new feature, a @@ -56,28 +180,26 @@ its merge target, allowing others to review, discuss and approve the changes.
  • Release Branches - Used both for short-term preparations of a release, and also for long-term maintenance of older version.
    • -
-

Git Common-Flow Specification (Common-Flow)

-

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, -“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be +

Git Common-Flow Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  1. The Master Branch
      -
    1. A branch named “master” MUST exist and it MUST be referred to as the -“master branch”.
      2. +
    2. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
    3. The master branch MUST be considered bleeding edge.
    4. The master branch MUST always be in a non-broken state with its test suite passing.
      5. -
    5. The master branch SHOULD always be in a “as near as possibly ready for -release/production” state to reduce any friction with creating a new +
    6. The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new release.
  2. Change Branches
    1. Each change (feature, bugfix, etc.) MUST be performed on separate -branches that SHOULD be referred to as “change branches”. All change +branches that SHOULD be referred to as "change branches". All change branches MUST have descriptive names. It is RECOMMENDED that you commit often locally, and you SHOULD regularly push your work to the same named branch on the remote server.
      2. @@ -85,21 +207,21 @@ branch on the remote server. change. You MUST NOT include multiple unrelated changes into a single change branch.
    2. When a change branch is created, the branch that it is created from -SHOULD be referred to as the “source branch”. Each change branch also -needs a designated “merge target” branch, typically this will be the same +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target" branch, typically this will be the same as the source branch.
    3. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
    4. After rebasing a change branch on top of its source branch you MUST push the change branch to the remote server. This will require you to do a -force push, and you SHOULD use the “—force-with-lease” git push option.
      5. +force push, and you SHOULD use the "--force-with-lease" git push option.
  3. Pull Requests
      -
    1. To merge a change branch into its merge target, you MUST open a “pull -request” (or equivalent) so others can review and approve your changes.
      2. +
    2. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent) so others can review and approve your changes.
    3. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target @@ -112,45 +234,45 @@ discuss the changes with others there.
    4. Versioning
      1. The project MUST have its version hard-coded somewhere in the -code-base. It is RECOMMENDED that this is done in a file called “VERSION” +code-base. It is RECOMMENDED that this is done in a file called "VERSION" located in the root of the project.
        2. -
      2. If you are using a “VERSION” file in the root of the project, this MUST +
      3. If you are using a "VERSION" file in the root of the project, this MUST only contain the exact version string.
      4. The version string SHOULD follow the Semantic Versioning (http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, -but the version string MUST NOT have a “v” prefix. For example “v2.11.4” -is bad, and “2.11.4” is good.
        5. +but the version string MUST NOT have a "v" prefix. For example "v2.11.4" +is bad, and "2.11.4" is good.
    5. Releases
        -
      1. To create a new release, you MUST create a “version bump” commit which +
      2. To create a new release, you MUST create a "version bump" commit which changes the hard-coded version string of the project. The version bump commit MUST have a git tag created on it and named as the exact version string.
      3. If you are not using a release branch, then the version bump commit MUST be created directly on the master branch.
        4. -
      4. The version bump commit MUST have a commit message title of “Bump version -to VERSION”. For example, if the new version string is “2.11.4”, the -first line of the commit message MUST read: “Bump version to 2.11.4”
        5. +
      5. The version bump commit MUST have a commit message title of "Bump version +to VERSION". For example, if the new version string is "2.11.4", the +first line of the commit message MUST read: "Bump version to 2.11.4"
      6. The release tag on the version bump commit MUST be named exactly the same as the version string. The tag name can OPTIONALLY be prefixed with -“v”. For example the tag name can be either “2.11.4” or “v2.11.4”. You -MUST not use a mix of “v” prefixed and non-prefixed tags. Pick one form +"v". For example the tag name can be either "2.11.4" or "v2.11.4". You +MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      7. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      8. If you use annotated release tags, the first line of the annotation MUST -read “Release VERSION”. For example for version “2.11.4” the first line -of the tag annotation would read “Release 2.11.4”. The second line must +read "Release VERSION". For example for version "2.11.4" the first line +of the tag annotation would read "Release 2.11.4". The second line must be blank, and the changelog MUST start on the third line.
    6. Release Branches
        -
      1. Any branch that has a name starting with “release-” SHOULD be referred to -as a “release branch”.
        2. +
      2. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
      3. Use of release branches is OPTIONAL.
      4. Changes in a release branch SHOULD typically come from work being done against the master branch. Meaning changes SHOULD only trickle @@ -164,8 +286,8 @@ branch in the first place. One exception to this is version bump commits.
      5. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
        6. -
      6. MUST have a name of “release-VERSION”. For example for version -“2.11.4” the release branch name MUST be “release-2.11.4”.
        7. +
      7. MUST have a name of "release-VERSION". For example for version +"2.11.4" the release branch name MUST be "release-2.11.4".
      8. When using a short-term release branch, the version bump commit and release tag MUST be made directly on the release branch itself.
      9. Only very minor changes should be performed on a short-term release @@ -185,16 +307,16 @@ branch. Typically this is useful when you need to create a new maintenance release for a older version.
      10. The branch name MUST have a non-specific version number. For example a long-term release branch for creating new 2.9.x releases would be -named “release-2.9”.
        11. +named "release-2.9".
      11. To create a new release from a long-term release branch, you MUST create a version bump commit and release tag directly on the release branch.
      12. A long-term release branch MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is -“2.9.7”. Create a new branch called “release-2.9” off of the “2.9.7” +"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" release tag. The security fix release will then end up being version -“2.9.8”.
        13. +"2.9.8".
    @@ -218,30 +340,36 @@ the relevant changes.
    4. the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project -
  4. You SHOULD never blindly commit all changes with “git commit -a”. It is -RECOMMENDED you use “git add -i” to add individual changes to the staging +
  5. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" to add individual changes to the staging area so you are fully aware of what you are committing.
    6. -
  6. You SHOULD always use “—force-with-lease” when doing a force push. The -regular “—force” option is dangerous and destructive. More +
  7. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
  8. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
    9. -
  9. It is RECOMMENDED that you always do “git pull —rebase” instead of “git -pull” to avoid unnecessary merge commits. You can make this the default -behavior of “git pull” with “git config —global pull.rebase true”.
    10. -
  10. It is RECOMMENDED that all branches be merged using “git merge —no-ff”. +
  11. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
    12. +
  12. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with master.
- -

About

-

The Git Common-Flow specification is authored -by Jim Myhrberg.

-

If you’d like to leave feedback, -please open an issue on GitHub.

-

License

-

Creative Commons - CC BY 3.0

\ No newline at end of file +

FAQ

+Common questions about Git Common-Flow +

\ No newline at end of file diff --git a/docs/spec/1.0.0-rc.3/index.html b/docs/spec/1.0.0-rc.3/index.html index 57b2d2d..6ef7f3d 100644 --- a/docs/spec/1.0.0-rc.3/index.html +++ b/docs/spec/1.0.0-rc.3/index.html @@ -1,46 +1,170 @@ - Git Common-Flow 1.0.0-rc.3 | Git Common Flow -

Git Common-Flow 1.0.0-rc.3

-Git Common-Flow 1.0.0-rc.3 diagram -

Summary

-

Common-Flow is an attempt to gather a sensible selection of the most common + 12a4 4 0 11-8 0 4 4 0 018 0z">

+Git Common-Flow +

+A sensible git workflow for teams who ship +

v1.0.0-rc.3
Git Common-Flow diagram

About Common-Flow

+A practical git workflow that combines the best of GitHub Flow with + versioned releases +

+Key Principles +

Common-Flow is an attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification. It is based on the original variant of GitHub Flow, while taking into account how a lot of open source projects use git.

In short, Common-Flow is essentially GitHub Flow with the addition of versioned releases, optional release branches, and without the requirement to deploy to -production all the time.

-

Terminology

-
    -
  • Master Branch - Must be named “master”, must always have passing tests, +production all the time.

+Author +

The Git Common-Flow specification is authored +by Jim Myhrberg.

+

If you'd like to leave feedback, +please open an issue on GitHub.

The Specification

+The complete Git Common-Flow specification +

Terminology

    +
  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a bug fix, etc.
    • @@ -57,36 +181,34 @@ environments. Consists of a version bump commit, and a git tag named according to the new version string placed on said commit.
  • Release Branches - Used both for short-term preparations of a release, and also for long-term maintenance of older version.
    • -
-

Git Common-Flow Specification (Common-Flow)

-

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, -“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be +

Git Common-Flow Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  1. TL;DR
      -
    1. Don’t break the master branch.
      2. +
    2. Don't break the master branch.
    3. A release is a git tag.
  2. The Master Branch
      -
    1. A branch named “master” MUST exist and it MUST be referred to as the -“master branch”.
      2. +
    2. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
    3. The master branch MUST always be in a non-broken state with its test suite passing.
    4. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      5. -
    5. The master branch SHOULD always be in a “as near as possibly ready for -release/production” state to reduce any friction with creating a new +
    6. The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new release.
  3. Change Branches
    1. Each change (feature, bugfix, etc.) MUST be performed on separate -branches that SHOULD be referred to as “change branches”. All change +branches that SHOULD be referred to as "change branches". All change branches MUST have descriptive names. It is RECOMMENDED that you commit often locally, and you SHOULD regularly push your work to the same named branch on the remote server.
      2. @@ -94,21 +216,21 @@ branch on the remote server. change. You MUST NOT include multiple unrelated changes into a single change branch.
    2. When a change branch is created, the branch that it is created from -SHOULD be referred to as the “source branch”. Each change branch also -needs a designated “merge target” branch, typically this will be the same +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target" branch, typically this will be the same as the source branch.
    3. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of the source branch.
    4. After rebasing a change branch on top of its source branch you MUST push the change branch to the remote server. This will require you to do a -force push, and you SHOULD use the “—force-with-lease” git push option.
      5. +force push, and you SHOULD use the "--force-with-lease" git push option.
  4. Pull Requests
      -
    1. To merge a change branch into its merge target, you MUST open a “pull -request” (or equivalent) so others can review and approve your changes.
      2. +
    2. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent) so others can review and approve your changes.
    3. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target @@ -121,45 +243,45 @@ discuss the changes with others there.
    4. Versioning
      1. The project MUST have its version hard-coded somewhere in the -code-base. It is RECOMMENDED that this is done in a file called “VERSION” +code-base. It is RECOMMENDED that this is done in a file called "VERSION" located in the root of the project.
        2. -
      2. If you are using a “VERSION” file in the root of the project, this MUST +
      3. If you are using a "VERSION" file in the root of the project, this MUST only contain the exact version string.
      4. The version string SHOULD follow the Semantic Versioning (http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, -but the version string MUST NOT have a “v” prefix. For example “v2.11.4” -is bad, and “2.11.4” is good.
        5. +but the version string MUST NOT have a "v" prefix. For example "v2.11.4" +is bad, and "2.11.4" is good.
    5. Releases
        -
      1. To create a new release, you MUST create a “version bump” commit which +
      2. To create a new release, you MUST create a "version bump" commit which changes the hard-coded version string of the project. The version bump commit MUST have a git tag created on it and named as the exact version string.
      3. If you are not using a release branch, then the version bump commit MUST be created directly on the master branch.
        4. -
      4. The version bump commit MUST have a commit message title of “Bump version -to VERSION”. For example, if the new version string is “2.11.4”, the -first line of the commit message MUST read: “Bump version to 2.11.4”
        5. +
      5. The version bump commit MUST have a commit message title of "Bump version +to VERSION". For example, if the new version string is "2.11.4", the +first line of the commit message MUST read: "Bump version to 2.11.4"
      6. The release tag on the version bump commit MUST be named exactly the same as the version string. The tag name can OPTIONALLY be prefixed with -“v”. For example the tag name can be either “2.11.4” or “v2.11.4”. You -MUST not use a mix of “v” prefixed and non-prefixed tags. Pick one form +"v". For example the tag name can be either "2.11.4" or "v2.11.4". You +MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
      7. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
      8. If you use annotated release tags, the first line of the annotation MUST -read “Release VERSION”. For example for version “2.11.4” the first line -of the tag annotation would read “Release 2.11.4”. The second line must +read "Release VERSION". For example for version "2.11.4" the first line +of the tag annotation would read "Release 2.11.4". The second line must be blank, and the changelog MUST start on the third line.
    6. Release Branches
        -
      1. Any branch that has a name starting with “release-” SHOULD be referred to -as a “release branch”.
        2. +
      2. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
      3. Use of release branches is OPTIONAL.
      4. Changes in a release branch SHOULD typically come from work being done against the master branch. Meaning changes SHOULD only trickle @@ -173,8 +295,8 @@ branch in the first place. One exception to this is version bump commits.
      5. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
        6. -
      6. MUST have a name of “release-VERSION”. For example for version -“2.11.4” the release branch name MUST be “release-2.11.4”.
        7. +
      7. MUST have a name of "release-VERSION". For example for version +"2.11.4" the release branch name MUST be "release-2.11.4".
      8. When using a short-term release branch, the version bump commit and release tag MUST be made directly on the release branch itself.
      9. Only very minor changes should be performed on a short-term release @@ -194,16 +316,16 @@ branch. Typically this is useful when you need to create a new maintenance release for a older version.
      10. The branch name MUST have a non-specific version number. For example a long-term release branch for creating new 2.9.x releases would be -named “release-2.9”.
        11. +named "release-2.9".
      11. To create a new release from a long-term release branch, you MUST create a version bump commit and release tag directly on the release branch.
      12. A long-term release branch MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x releases, the latest of which is -“2.9.7”. Create a new branch called “release-2.9” off of the “2.9.7” +"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" release tag. The security fix release will then end up being version -“2.9.8”.
        13. +"2.9.8".
    @@ -227,30 +349,36 @@ the relevant changes.
    5. the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines -
  5. You SHOULD never blindly commit all changes with “git commit -a”. It is -RECOMMENDED you use “git add -i” to add individual changes to the staging +
  6. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" to add individual changes to the staging area so you are fully aware of what you are committing.
    7. -
  7. You SHOULD always use “—force-with-lease” when doing a force push. The -regular “—force” option is dangerous and destructive. More +
  8. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
  9. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
    10. -
  10. It is RECOMMENDED that you always do “git pull —rebase” instead of “git -pull” to avoid unnecessary merge commits. You can make this the default -behavior of “git pull” with “git config —global pull.rebase true”.
    11. -
  11. It is RECOMMENDED that all branches be merged using “git merge —no-ff”. +
  12. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
    13. +
  13. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with master.
- -

About

-

The Git Common-Flow specification is authored -by Jim Myhrberg.

-

If you’d like to leave feedback, -please open an issue on GitHub.

-

License

-

Creative Commons - CC BY 3.0

\ No newline at end of file +

FAQ

+Common questions about Git Common-Flow +

\ No newline at end of file diff --git a/docs/spec/1.0.0-rc.4/index.html b/docs/spec/1.0.0-rc.4/index.html index 165d9b6..a8bb004 100644 --- a/docs/spec/1.0.0-rc.4/index.html +++ b/docs/spec/1.0.0-rc.4/index.html @@ -1,46 +1,170 @@ - Git Common-Flow 1.0.0-rc.4 | Git Common Flow -

Git Common-Flow 1.0.0-rc.4

-Git Common-Flow 1.0.0-rc.4 diagram -

Summary

-

Common-Flow is an attempt to gather a sensible selection of the most common + 12a4 4 0 11-8 0 4 4 0 018 0z">

+Git Common-Flow +

+A sensible git workflow for teams who ship +

v1.0.0-rc.4
Git Common-Flow diagram

About Common-Flow

+A practical git workflow that combines the best of GitHub Flow with + versioned releases +

+Key Principles +

Common-Flow is an attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification. It is based on the original variant of GitHub Flow, while taking into account how a lot of open source projects use git.

In short, Common-Flow is essentially GitHub Flow with the addition of versioned releases, optional release branches, and without the requirement to deploy to -production all the time.

-

Terminology

-
    -
  • Master Branch - Must be named “master”, must always have passing tests, +production all the time.

+Author +

The Git Common-Flow specification is authored +by Jim Myhrberg.

+

If you'd like to leave feedback, +please open an issue on GitHub.

The Specification

+The complete Git Common-Flow specification +

Terminology

    +
  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a bug fix, etc.
    • @@ -56,36 +180,34 @@ its merge target, allowing others to review, discuss and approve the changes.
  • Release Branches - Used both for short-term preparations of a release, and also for long-term maintenance of older version.
    • -
-

Git Common-Flow Specification (Common-Flow)

-

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, -“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be +

Git Common-Flow Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  1. TL;DR
      -
    1. Don’t break the master branch.
      2. +
    2. Don't break the master branch.
    3. A release is a git tag.
  2. The Master Branch
      -
    1. A branch named “master” MUST exist and it MUST be referred to as the -“master branch”.
      2. +
    2. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
    3. The master branch MUST always be in a non-broken state with its test suite passing.
    4. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      5. -
    5. The master branch SHOULD always be in a “as near as possibly ready for -release/production” state to reduce any friction with creating a new +
    6. The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new release.
  3. Change Branches
    1. Each change (feature, bugfix, etc.) MUST be performed on separate -branches that SHOULD be referred to as “change branches”.
      2. +branches that SHOULD be referred to as "change branches".
    2. All change branches MUST have descriptive names.
    3. It is RECOMMENDED that you commit often locally, and that you try and keep the commits reasonably structured to avoid a messy and confusing git @@ -96,8 +218,8 @@ remote server.
      4. change. You SHOULD NOT include multiple unrelated changes into a single change branch.
    4. When a change branch is created, the branch that it is created from -SHOULD be referred to as the “source branch”. Each change branch also -needs a designated “merge target” branch, typically this will be the same +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target" branch, typically this will be the same as the source branch.
    5. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of @@ -105,8 +227,8 @@ the source branch.
    6. After updating a change branch from its source branch you MUST push the change branch to the remote server. Due to the nature of rebasing, you will be required to do a force push, and you MUST use the -“—force-with-lease” git push option when doing so instead of the regular -“—force”.
      7. +"--force-with-lease" git push option when doing so instead of the regular +"--force".
    7. If there is a truly valid technical reason to not use rebase when updating change branches, then you can update change branches via merge instead of rebase. The decision to use merge MUST only be taken after all @@ -118,15 +240,15 @@ of both methods, pick one and stick to it.
    8. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a “pull -request” (or equivalent).
        2. +
      2. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent).
      3. The purpose of a pull request is to allow others to review your changes and give feedback. You can then fix any issues, complaints, and more that might arise, and then let people review again.
      4. Before creating a pull request, it is RECOMMENDED that you consider the -state of your change branch’s commit history. If it is messy and -confusing, it might be a good idea to rebase your branch with “git rebase --i” to present a cleaner and easier to follow commit history for your +state of your change branch's commit history. If it is messy and +confusing, it might be a good idea to rebase your branch with "git rebase +-i" to present a cleaner and easier to follow commit history for your reviewers.
      5. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are @@ -139,23 +261,23 @@ discuss the changes with others there.
      6. Versioning
          -
        1. A “version string” is a typically mostly numeric string that identifies a +
        2. A "version string" is a typically mostly numeric string that identifies a specific version of a project. The version string itself MUST NOT have a -“v” prefix, but the version string can be displayed with a “v” prefix to +"v" prefix, but the version string can be displayed with a "v" prefix to indicate it is a version that is being referred to.
          3. -
        3. The source of truth for a project’s version MUST be a git tag with a name +
        4. The source of truth for a project's version MUST be a git tag with a name based on the version string. This kind of tag MUST be referred to as a -“release tag”.
          5. +"release tag".
        5. It is OPTIONAL, but RECOMMENDED to also keep the version string hard-coded somewhere in the project code-base.
        6. If you hard-code the version string into the code-base, it is RECOMMENDED -that you do so in a file called “VERSION” located in the root of the +that you do so in a file called "VERSION" located in the root of the project. But be mindful of the conventions of your programming language and community when choosing if, where and how to hard-code the version string.
          7. -
        7. If you are using a “VERSION” file in the root of the project, this file +
        8. If you are using a "VERSION" file in the root of the project, this file MUST only contain the exact version string, meaning it MUST NOT have a -“v” prefix. For example “v2.11.4” is bad, and “2.11.4” is good.
          9. +"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
        9. It is OPTIONAL, but RECOMMENDED that that the version string follows Semantic Versioning (http://semver.org/).
        @@ -164,46 +286,46 @@ Semantic Versioning (http://semver.org/).
        1. To create a new release, you MUST create a git tag named as the exact version string of the release. This kind of tag MUST be referred to as a -“release tag”.
          2. -
        2. The release tag name can OPTIONALLY be prefixed with “v”. For example the -tag name can be either “2.11.4” or “v2.11.4”. It is however RECOMMENDED -that you do not use a “v” prefix. You MUST NOT use a mixture of “v” +"release tag".
          3. +
        3. The release tag name can OPTIONALLY be prefixed with "v". For example the +tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED +that you do not use a "v" prefix. You MUST NOT use a mixture of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
        4. If the version string is hard-coded into the code-base, you MUST create a -“version bump” commit which changes the hard-coded version string of the +"version bump" commit which changes the hard-coded version string of the project.
        5. When using version bump commits, the release tag MUST be placed on the version bump commit.
        6. If you are not using a release branch, then the release tag, and if relevant the version bump commit, MUST be created directly on the master branch.
          7. -
        7. The version bump commit SHOULD have a commit message title of “Bump -version to VERSION”. For example, if the new version string is “2.11.4”, -the first line of the commit message SHOULD read: “Bump version to -2.11.4”
          8. +
        8. The version bump commit SHOULD have a commit message title of "Bump +version to VERSION". For example, if the new version string is "2.11.4", +the first line of the commit message SHOULD read: "Bump version to +2.11.4"
        9. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
        10. If you use annotated release tags, the first line of the annotation -SHOULD read “Release VERSION”. For example for version “2.11.4” the first -line of the tag annotation SHOULD read “Release 2.11.4”. The second line +SHOULD read "Release VERSION". For example for version "2.11.4" the first +line of the tag annotation SHOULD read "Release 2.11.4". The second line MUST be blank, and the changelog MUST start on the third line.
      7. Short-Term Release Branches
          -
        1. Any branch that has a name starting with “release-” SHOULD be referred to -as a “release branch”.
          2. +
        2. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
        3. Any release branch which has a name ending with a specific version -string, MUST be referred to as a “short-term release branch”.
          4. +string, MUST be referred to as a "short-term release branch".
        4. Use of short-term release branches are OPTIONAL, and intended to be used to create a specific versioned release.
        5. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
          6. -
        6. Short-term release branches MUST have a name of “release-VERSION”. For -example for version “2.11.4” the release branch name MUST be -“release-2.11.4”.
          7. +
        7. Short-term release branches MUST have a name of "release-VERSION". For +example for version "2.11.4" the release branch name MUST be +"release-2.11.4".
        8. When using a short-term release branch to create a release, the release tag and if used, version bump commit, MUST be placed directly on the short-term release branch itself.
          9. @@ -220,8 +342,8 @@ will be the master branch.
        9. Long-term Release Branches
          1. Any release branch which has a name ending with a non-specific version -string, MUST be referred to as a “long-term release branch”. For example -“release-2.11” is a long-term release branch, while “release-2.11.4” is a +string, MUST be referred to as a "long-term release branch". For example +"release-2.11" is a long-term release branch, while "release-2.11.4" is a short-term release branch.
          2. Use of long-term release branches are OPTIONAL, and intended for work on versions which are not currently part of the master branch. Typically @@ -229,13 +351,13 @@ this is useful when you need to create a new maintenance release for a older version.
          3. A long-term release branch MUST have a name with a non-specific version number. For example a long-term release branch for creating new 2.9.x -releases MUST be named “release-2.9”.
            4. +releases MUST be named "release-2.9".
          4. Long-term release branches for maintenance releases of older versions MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x -releases, the latest of which is “2.9.7”. Create a new branch called -“release-2.9” off of the “2.9.7” release tag. The security fix release -will then end up being version “2.9.8”.
            5. +releases, the latest of which is "2.9.7". Create a new branch called +"release-2.9" off of the "2.9.7" release tag. The security fix release +will then end up being version "2.9.8".
          5. To create a new release from a long-term release branch, you MUST follow the same process as a release from the master branch, except the long-term release branch takes the place of the master branch.
            6. @@ -265,73 +387,69 @@ the relevant changes. the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines -
          6. You SHOULD never blindly commit all changes with “git commit -a”. It is -RECOMMENDED you use “git add -i” or “git add -p” to add individual +
          7. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" or "git add -p" to add individual changes to the staging area so you are fully aware of what you are committing.
            8. -
          8. You SHOULD always use “—force-with-lease” when doing a force push. The -regular “—force” option is dangerous and destructive. More +
          9. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
          10. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
            11. -
          11. It is RECOMMENDED that you always do “git pull —rebase” instead of “git -pull” to avoid unnecessary merge commits. You can make this the default -behavior of “git pull” with “git config —global pull.rebase true”.
            12. -
          12. It is RECOMMENDED that all branches be merged using “git merge —no-ff”. +
          13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
            14. +
          14. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with master.
          10. -
        -

        FAQ

        -

        Why use Common-Flow instead of Git Flow, and how does it differ?

        -

        Common-Flow tries to be a lot less complicated than Git Flow by having fewer -types of branches, and simpler rules. Normal day to day development doesn’t +

FAQ

+Common questions about Git Common-Flow +

\ No newline at end of file +that's preventing a new release from master. But if that proves to be a +complicated task and you're short on time, a short-term release branch gives you +a instant fix to the situation at hand, and let's you resolve the issues with +the master branch when you have more time on your hands.

\ No newline at end of file diff --git a/docs/spec/1.0.0-rc.5/index.html b/docs/spec/1.0.0-rc.5/index.html index 85a009e..b56bfb1 100644 --- a/docs/spec/1.0.0-rc.5/index.html +++ b/docs/spec/1.0.0-rc.5/index.html @@ -1,59 +1,181 @@ - Git Common-Flow 1.0.0-rc.5 | Git Common Flow -

Git Common-Flow 1.0.0-rc.5

-Git Common-Flow 1.0.0-rc.5 diagram -

Introduction

-

Common-Flow is an attempt to gather a sensible selection of the most common + 12a4 4 0 11-8 0 4 4 0 018 0z">

+Git Common-Flow +

+A sensible git workflow for teams who ship +

v1.0.0-rc.5
Git Common-Flow diagram

About Common-Flow

+A practical git workflow that combines the best of GitHub Flow with + versioned releases +

Common-Flow is an attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification. It is based on the original variant of GitHub Flow, while taking into account how a lot of open source projects most commonly use git.

In short, Common-Flow is essentially GitHub Flow with the addition of versioned releases, optional release branches, and without the requirement to deploy to -production all the time.

-

Summary

-
    -
  • The “master” branch is the mainline branch with latest changes, and must not +production all the time.

+Key Principles +

    +
  • The "master" branch is the mainline branch with latest changes, and must not be broken.
    • -
  • Changes (features, bugfixes, etc.) are done on “change branches” created from +
  • Changes (features, bugfixes, etc.) are done on "change branches" created from the master branch.
  • Rebase change branches early and often.
  • When a change branch is stable and ready, it is merged back in to master.
    • -
  • A release is just a git tag who’s name is the exact release version string -(e.g. “2.11.4”).
    • +
  • A release is just a git tag who's name is the exact release version string +(e.g. "2.11.4").
  • Release branches can be used to avoid change freezes on master. They are not required, instead they are available if you need them.
    • -
-

Terminology

-
    -
  • Master Branch - Must be named “master”, must always have passing tests, +

+Author +

The Git Common-Flow specification is authored +by Jim Myhrberg.

+

If you'd like to leave feedback, +please open an issue on GitHub.

The Specification

+The complete Git Common-Flow specification +

Terminology

    +
  • Master Branch - Must be named "master", must always have passing tests, and is not guaranteed to always work in production environments.
  • Change Branches - Any branch that introduces changes like a new feature, a bug fix, etc.
    • @@ -69,10 +191,8 @@ its merge target, allowing others to review, discuss and approve the changes.
  • Release Branches - Used both for short-term preparations of a release, and also for long-term maintenance of older version.
    • -
-

Git Common-Flow Specification (Common-Flow)

-

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, -“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be +

Git Common-Flow Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

  1. TL;DR @@ -83,22 +203,22 @@ interpreted as described in RFC 21
  2. The Master Branch
      -
    1. A branch named “master” MUST exist and it MUST be referred to as the -“master branch”.
      2. +
    2. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
    3. The master branch MUST always be in a non-broken state with its test suite passing.
    4. The master branch IS NOT guaranteed to always work in production environments. Despite test suites passing it may at times contain unfinished work. Only releases may be considered safe for production use.
      5. -
    5. The master branch SHOULD always be in a “as near as possibly ready for -release/production” state to reduce any friction with creating a new +
    6. The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new release.
  3. Change Branches
    1. Each change (feature, bugfix, etc.) MUST be performed on separate -branches that SHOULD be referred to as “change branches”.
      2. +branches that SHOULD be referred to as "change branches".
    2. All change branches MUST have descriptive names.
    3. It is RECOMMENDED that you commit often locally, and that you try and keep the commits reasonably structured to avoid a messy and confusing git @@ -109,8 +229,8 @@ remote server.
      4. change. You SHOULD NOT include multiple unrelated changes into a single change branch.
    4. When a change branch is created, the branch that it is created from -SHOULD be referred to as the “source branch”. Each change branch also -needs a designated “merge target” branch, typically this will be the same +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target" branch, typically this will be the same as the source branch.
    5. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of @@ -118,8 +238,8 @@ the source branch.
    6. After updating a change branch from its source branch you MUST push the change branch to the remote server. Due to the nature of rebasing, you will be required to do a force push, and you MUST use the -“—force-with-lease” git push option when doing so instead of the regular -“—force”.
      7. +"--force-with-lease" git push option when doing so instead of the regular +"--force".
    7. If there is a truly valid technical reason to not use rebase when updating change branches, then you can update change branches via merge instead of rebase. The decision to use merge MUST only be taken after all @@ -131,15 +251,15 @@ of both methods, pick one and stick to it.
    8. Pull Requests
        -
      1. To merge a change branch into its merge target, you MUST open a “pull -request” (or equivalent).
        2. +
      2. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent).
      3. The purpose of a pull request is to allow others to review your changes and give feedback. You can then fix any issues, complaints, and more that might arise, and then let people review again.
      4. Before creating a pull request, it is RECOMMENDED that you consider the -state of your change branch’s commit history. If it is messy and -confusing, it might be a good idea to rebase your branch with “git rebase --i” to present a cleaner and easier to follow commit history for your +state of your change branch's commit history. If it is messy and +confusing, it might be a good idea to rebase your branch with "git rebase +-i" to present a cleaner and easier to follow commit history for your reviewers.
      5. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are @@ -153,23 +273,23 @@ how, when, and why the code looks and behaves the way it does.
      6. Versioning
          -
        1. A “version string” is a typically mostly numeric string that identifies a +
        2. A "version string" is a typically mostly numeric string that identifies a specific version of a project. The version string itself MUST NOT have a -“v” prefix, but the version string can be displayed with a “v” prefix to +"v" prefix, but the version string can be displayed with a "v" prefix to indicate it is a version that is being referred to.
          3. -
        3. The source of truth for a project’s version MUST be a git tag with a name +
        4. The source of truth for a project's version MUST be a git tag with a name based on the version string. This kind of tag MUST be referred to as a -“release tag”.
          5. +"release tag".
        5. It is OPTIONAL, but RECOMMENDED to also keep the version string hard-coded somewhere in the project code-base.
        6. If you hard-code the version string into the code-base, it is RECOMMENDED -that you do so in a file called “VERSION” located in the root of the +that you do so in a file called "VERSION" located in the root of the project. But be mindful of the conventions of your programming language and community when choosing if, where and how to hard-code the version string.
          7. -
        7. If you are using a “VERSION” file in the root of the project, this file +
        8. If you are using a "VERSION" file in the root of the project, this file MUST only contain the exact version string, meaning it MUST NOT have a -“v” prefix. For example “v2.11.4” is bad, and “2.11.4” is good.
          9. +"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
        9. It is OPTIONAL, but RECOMMENDED that that the version string follows Semantic Versioning (http://semver.org/).
        @@ -178,46 +298,46 @@ Semantic Versioning (http://semver.org/).
        1. To create a new release, you MUST create a git tag named as the exact version string of the release. This kind of tag MUST be referred to as a -“release tag”.
          2. -
        2. The release tag name can OPTIONALLY be prefixed with “v”. For example the -tag name can be either “2.11.4” or “v2.11.4”. It is however RECOMMENDED -that you do not use a “v” prefix. You MUST NOT use a mixture of “v” +"release tag".
          3. +
        3. The release tag name can OPTIONALLY be prefixed with "v". For example the +tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED +that you do not use a "v" prefix. You MUST NOT use a mixture of "v" prefixed and non-prefixed tags. Pick one form and stick to it.
        4. If the version string is hard-coded into the code-base, you MUST create a -“version bump” commit which changes the hard-coded version string of the +"version bump" commit which changes the hard-coded version string of the project.
        5. When using version bump commits, the release tag MUST be placed on the version bump commit.
        6. If you are not using a release branch, then the release tag, and if relevant the version bump commit, MUST be created directly on the master branch.
          7. -
        7. The version bump commit SHOULD have a commit message title of “Bump -version to VERSION”. For example, if the new version string is “2.11.4”, -the first line of the commit message SHOULD read: “Bump version to -2.11.4”
          8. +
        8. The version bump commit SHOULD have a commit message title of "Bump +version to VERSION". For example, if the new version string is "2.11.4", +the first line of the commit message SHOULD read: "Bump version to +2.11.4"
        9. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
        10. If you use annotated release tags, the first line of the annotation -SHOULD read “Release VERSION”. For example for version “2.11.4” the first -line of the tag annotation SHOULD read “Release 2.11.4”. The second line +SHOULD read "Release VERSION". For example for version "2.11.4" the first +line of the tag annotation SHOULD read "Release 2.11.4". The second line MUST be blank, and the changelog MUST start on the third line.
      7. Short-Term Release Branches
          -
        1. Any branch that has a name starting with “release-” SHOULD be referred to -as a “release branch”.
          2. +
        2. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
        3. Any release branch which has a name ending with a specific version -string, MUST be referred to as a “short-term release branch”.
          4. +string, MUST be referred to as a "short-term release branch".
        4. Use of short-term release branches are OPTIONAL, and intended to be used to create a specific versioned release.
        5. A short-term release branch is RECOMMENDED if there is a lengthy pre-release verification process to avoid a code freeze on the master branch.
          6. -
        6. Short-term release branches MUST have a name of “release-VERSION”. For -example for version “2.11.4” the release branch name MUST be -“release-2.11.4”.
          7. +
        7. Short-term release branches MUST have a name of "release-VERSION". For +example for version "2.11.4" the release branch name MUST be +"release-2.11.4".
        8. When using a short-term release branch to create a release, the release tag and if used, version bump commit, MUST be placed directly on the short-term release branch itself.
          9. @@ -234,8 +354,8 @@ will be the master branch.
        9. Long-term Release Branches
          1. Any release branch which has a name ending with a non-specific version -string, MUST be referred to as a “long-term release branch”. For example -“release-2.11” is a long-term release branch, while “release-2.11.4” is a +string, MUST be referred to as a "long-term release branch". For example +"release-2.11" is a long-term release branch, while "release-2.11.4" is a short-term release branch.
          2. Use of long-term release branches are OPTIONAL, and intended for work on versions which are not currently part of the master branch. Typically @@ -243,13 +363,13 @@ this is useful when you need to create a new maintenance release for a older version.
          3. A long-term release branch MUST have a name with a non-specific version number. For example a long-term release branch for creating new 2.9.x -releases MUST be named “release-2.9”.
            4. +releases MUST be named "release-2.9".
          4. Long-term release branches for maintenance releases of older versions MUST be created from the relevant release tag. For example if the master branch is on version 2.11.4 and there is a security fix for all 2.9.x -releases, the latest of which is “2.9.7”. Create a new branch called -“release-2.9” from the “2.9.7” release tag. The security fix release will -then end up being version “2.9.8”.
            5. +releases, the latest of which is "2.9.7". Create a new branch called +"release-2.9" from the "2.9.7" release tag. The security fix release will +then end up being version "2.9.8".
          5. To create a new release from a long-term release branch, you MUST follow the same process as a release from the master branch, except the long-term release branch takes the place of the master branch.
            6. @@ -279,73 +399,69 @@ the relevant changes. the official git documentation: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines -
          6. You SHOULD never blindly commit all changes with “git commit -a”. It is -RECOMMENDED you use “git add -i” or “git add -p” to add individual +
          7. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" or "git add -p" to add individual changes to the staging area so you are fully aware of what you are committing.
            8. -
          8. You SHOULD always use “—force-with-lease” when doing a force push. The -regular “—force” option is dangerous and destructive. More +
          9. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More information: https://developer.atlassian.com/blog/2015/04/force-with-lease/
          10. You SHOULD understand and be comfortable with rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
            11. -
          11. It is RECOMMENDED that you always do “git pull —rebase” instead of “git -pull” to avoid unnecessary merge commits. You can make this the default -behavior of “git pull” with “git config —global pull.rebase true”.
            12. -
          12. It is RECOMMENDED that all branches be merged using “git merge —no-ff”. +
          13. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
            14. +
          14. It is RECOMMENDED that all branches be merged using "git merge --no-ff". This makes sure the reference to the original branch is kept in the commits, allows one to revert a merge by reverting a single merge commit, and creates a merge commit to mark the integration of the branch with master.
          10. -
        -

        FAQ

        -

        Why use Common-Flow instead of Git Flow, and how does it differ?

        -

        Common-Flow tries to be a lot less complicated than Git Flow by having fewer -types of branches, and simpler rules. Normal day to day development doesn’t +

FAQ

+Common questions about Git Common-Flow +

\ No newline at end of file +that's preventing a new release from master. But if that proves to be a +complicated task and you're short on time, a short-term release branch gives you +a instant fix to the situation at hand, and let's you resolve the issues with +the master branch when you have more time on your hands.

\ No newline at end of file diff --git a/package.json b/package.json index f2d9344..a585e02 100644 --- a/package.json +++ b/package.json @@ -10,13 +10,17 @@ "astro": "astro" }, "dependencies": { - "@astrojs/sitemap": "^3.2.1", - "astro": "^5.1.1" + "@astrojs/sitemap": "^3.6.1", + "astro": "^5.16.8", + "rehype-stringify": "^10.0.1", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.1.2", + "unified": "^11.0.5" }, "devDependencies": { - "@tailwindcss/typography": "^0.5.16", - "@tailwindcss/vite": "^4.0.0", - "tailwindcss": "^4.0.0", - "typescript": "^5.7.2" + "@tailwindcss/typography": "^0.5.19", + "@tailwindcss/vite": "^4.1.18", + "tailwindcss": "^4.1.18", + "typescript": "^5.9.3" } } diff --git a/src/components/AboutSection.astro b/src/components/AboutSection.astro new file mode 100644 index 0000000..671a7c9 --- /dev/null +++ b/src/components/AboutSection.astro @@ -0,0 +1,96 @@ +--- +interface Props { + introduction: string; + summary: string; + about: string; + license: string; +} + +const { introduction, summary, about, license } = Astro.props; +--- + +
+
+
+ +
+

About Common-Flow

+

+ A practical git workflow that combines the best of GitHub Flow with + versioned releases +

+
+ + +
+
+
+ + +
+

+ Key Principles +

+
+
+ + +
+
+
+

+ Author +

+
+
+
+

+ License +

+
+
+
+
+
+
+
+ + diff --git a/src/components/FAQSection.astro b/src/components/FAQSection.astro new file mode 100644 index 0000000..e0d03c9 --- /dev/null +++ b/src/components/FAQSection.astro @@ -0,0 +1,139 @@ +--- +import type { FAQItem } from "../utils/parseSpecContent"; + +interface Props { + items: FAQItem[]; +} + +const { items } = Astro.props; +--- + +
+
+
+ +
+

FAQ

+

+ Common questions about Git Common-Flow +

+
+ + +
+ { + items.map((item, index) => ( +
+ + + )) + } +
+
+
+
+ + + + diff --git a/src/components/Header.astro b/src/components/Header.astro new file mode 100644 index 0000000..e387a38 --- /dev/null +++ b/src/components/Header.astro @@ -0,0 +1,186 @@ +--- +import VersionSelector from "./VersionSelector.astro"; +import ThemeToggle from "./ThemeToggle.astro"; +import { config } from "../config"; + +interface Props { + version: string; +} + +const { version } = Astro.props; +--- + +
+
+ + + + Git Common-Flow + + + + + + + +
+ + + + + + + + + + + + +
+
+ + + +
+ + + + diff --git a/src/components/Hero.astro b/src/components/Hero.astro new file mode 100644 index 0000000..7844317 --- /dev/null +++ b/src/components/Hero.astro @@ -0,0 +1,149 @@ +--- +import VersionSelector from "./VersionSelector.astro"; +import ThemeToggle from "./ThemeToggle.astro"; +import { config } from "../config"; + +interface Props { + version: string; + svgPath: string; +} + +const { version, svgPath } = Astro.props; +--- + +
+ +
+
+ + +
+
+ + +
+
+ +
+
+ + + + + + +
+
+ + +
+ +

+ Git Common-Flow +

+ + +

+ A sensible git workflow for teams who ship +

+ + +
+ v{version} +
+ + +
+ Git Common-Flow diagram +
+ + + +
+ + + + + + + +
diff --git a/src/components/MenuToggle.astro b/src/components/MenuToggle.astro deleted file mode 100644 index 27fe87f..0000000 --- a/src/components/MenuToggle.astro +++ /dev/null @@ -1,100 +0,0 @@ ---- -// Mobile hamburger menu toggle button ---- - - - - - - - - diff --git a/src/components/Sidebar.astro b/src/components/Sidebar.astro deleted file mode 100644 index 5bfdc7c..0000000 --- a/src/components/Sidebar.astro +++ /dev/null @@ -1,163 +0,0 @@ ---- -import { config } from "../config"; -import ThemeToggle from "./ThemeToggle.astro"; - -interface Props { - currentVersion?: string; -} - -const { currentVersion } = Astro.props; ---- - - - - diff --git a/src/components/SpecSection.astro b/src/components/SpecSection.astro new file mode 100644 index 0000000..2b21a1e --- /dev/null +++ b/src/components/SpecSection.astro @@ -0,0 +1,179 @@ +--- +import SpecSidebar from "./SpecSidebar.astro"; +import type { TocItem } from "../utils/parseSpecContent"; + +interface Props { + terminology: string; + specification: string; + tocItems: TocItem[]; +} + +const { terminology, specification, tocItems } = Astro.props; +--- + +
+
+ +
+

The Specification

+

+ The complete Git Common-Flow specification +

+
+ + +
+ +
+ +
+ + +
+
+ +
+

Terminology

+ +
+ + +
+

Git Common-Flow Specification

+ +
+
+
+
+
+
+ + diff --git a/src/components/SpecSidebar.astro b/src/components/SpecSidebar.astro new file mode 100644 index 0000000..3e9104e --- /dev/null +++ b/src/components/SpecSidebar.astro @@ -0,0 +1,219 @@ +--- +import type { TocItem } from "../utils/parseSpecContent"; + +interface Props { + items: TocItem[]; +} + +const { items } = Astro.props; +--- + + + + + + + + + + + + diff --git a/src/components/ThemeToggle.astro b/src/components/ThemeToggle.astro index 99212c6..09cc88d 100644 --- a/src/components/ThemeToggle.astro +++ b/src/components/ThemeToggle.astro @@ -3,16 +3,21 @@ ---