jimeh/commonflow.org
1
0
Fork 0
mirror of https://github.com/jimeh/commonflow.org.git synced 2026-02-19 05:46:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10 from jimeh/migrate-to-astro

Browse Source
This commit is contained in:
Jim Myhrberg
2026-01-13 07:07:09 +00:00
committed by GitHub
parent 04d807c388 a51a957530
commit b6e1c794d2
66 changed files with 9577 additions and 3276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
.claude/settings.json Normal file
View File

@@ -0,0 +1,11 @@
{
"permissions": {
"allow": [
"Bash(npm install:*)",
"Bash(npm run build:*)",
"Bash(npm run update:*)",
"Bash(npm run dev:*)",
"Bash(npm run preview:*)",
]
}
}

18
.gitignore vendored
View File

@@ -1,5 +1,23 @@
# Astro
dist/
.astro/
# Node
node_modules/
# Jekyll (legacy, can be removed after full migration)
_site _site
.asset-cache .asset-cache
.sass-cache .sass-cache
.jekyll-metadata .jekyll-metadata
.jekyll-cache
docs/assets/.sprockets-manifest-*.json docs/assets/.sprockets-manifest-*.json
# Editor
.DS_Store
*.swp
*.swo
# Environment
.env
.env.*

2
.mise.toml Normal file
View File

@@ -0,0 +1,2 @@
[tools]
node = "lts"

4
.vscode/extensions.json vendored Normal file
View File

@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}

11
.vscode/launch.json vendored Normal file
View File

@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm run dev",
"name": "dev server",
"request": "launch",
"type": "node-terminal"
}
]
}

9
404.html
View File

@@ -1,9 +0,0 @@
---
title: 404 Page Not Found
sitemap: false
---
<div class="header">
<h1>404</h1>
<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>

56
CLAUDE.md Normal file
View File

@@ -0,0 +1,56 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with
code in this repository.
## Project Overview
This is the source for commonflow.org, an Astro-based static site that documents
the Git Common-Flow specification. Common-Flow is a git workflow specification
that combines GitHub Flow with versioned releases.
## Build Commands
```bash
# Install dependencies
npm install
# Development server
npm run dev
# Build site (outputs to docs/ directory)
npm run build
# Preview built site
npm run preview
# Update specs from upstream (fetches from github.com/jimeh/common-flow)
npm run update
```
The site is built to `docs/` for GitHub Pages hosting.
## Architecture
- **Astro 5.x** static site generator
- **Tailwind CSS 4.x** for styling with dark mode support
- **Content Collections** for spec markdown files
- **TypeScript** throughout
### Key Files
- `src/config.ts` - Site configuration with version list
- `src/content.config.ts` - Astro content collection definition
- `src/layouts/Default.astro` - Main layout with sidebar
- `src/components/` - Sidebar, MenuToggle, ThemeToggle components
- `src/pages/spec/[version].astro` - Dynamic route for spec versions
- `src/content/spec/*.md` - Versioned spec documents
- `public/spec/*.svg` - SVG diagrams for each version
- `scripts/update-specs.ts` - Fetches specs from GitHub
### Updating Spec Versions
1. Add new version to `versions` array in `src/config.ts`
2. Update `currentVersion` if this is the new default
3. Run `npm run update` to fetch specs from GitHub
4. Run `npm run build` to rebuild the site

21
Gemfile
View File

@@ -1,21 +0,0 @@
source 'https://rubygems.org'
gem 'jekyll', '3.5.0'
group :development do
gem 'rake'
gem 'rubocop'
end
# If you have any plugins, put them here!
group :jekyll_plugins do
gem 'jekyll-assets'
gem 'jekyll-pants'
gem 'jekyll-seo-tag'
gem 'jekyll-sitemap'
gem 'jekyll-tidy'
gem 'uglifier' # required by 'jekyll-assets' for JS compression
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]

104
Gemfile.lock
View File

@@ -1,104 +0,0 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2)
ast (2.4.0)
colorator (1.1.0)
concurrent-ruby (1.0.5)
execjs (2.7.0)
extras (0.3.0)
forwardable-extended (~> 2.5)
fastimage (2.1.0)
ffi (1.9.18)
forwardable-extended (2.6.0)
htmlbeautifier (1.3.1)
htmlcompressor (0.3.1)
jekyll (3.5.0)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-assets (2.3.2)
concurrent-ruby (~> 1.0)
extras (~> 0.2)
fastimage (~> 2.0, >= 1.8)
jekyll (~> 3.1, >= 3.0)
pathutil (>= 0.8)
rack (~> 1.6)
sprockets (~> 3.3, < 3.8)
jekyll-pants (0.2.1)
rubypants
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-seo-tag (2.2.3)
jekyll (~> 3.3)
jekyll-sitemap (1.0.0)
jekyll (~> 3.3)
jekyll-tidy (0.2.2)
htmlbeautifier
htmlcompressor
jekyll
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
kramdown (1.14.0)
liquid (4.0.0)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
mercenary (0.3.6)
parallel (1.12.1)
parser (2.5.1.0)
ast (~> 2.4.0)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
powerpack (0.1.1)
public_suffix (2.0.5)
rack (1.6.8)
rainbow (3.0.0)
rake (12.0.0)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (1.11.1)
rubocop (0.56.0)
parallel (~> 1.10)
parser (>= 2.5)
powerpack (~> 0.1)
rainbow (>= 2.2.2, < 4.0)
ruby-progressbar (~> 1.7)
unicode-display_width (~> 1.0, >= 1.0.1)
ruby-progressbar (1.9.0)
rubypants (0.6.0)
safe_yaml (1.0.4)
sass (3.4.25)
sprockets (3.7.1)
concurrent-ruby (~> 1.0)
rack (> 1, < 3)
uglifier (3.2.0)
execjs (>= 0.3.0, < 3)
unicode-display_width (1.3.2)
PLATFORMS
ruby
DEPENDENCIES
jekyll (= 3.5.0)
jekyll-assets
jekyll-pants
jekyll-seo-tag
jekyll-sitemap
jekyll-tidy
rake
rubocop
tzinfo-data
uglifier
BUNDLED WITH
1.16.1

85
Rakefile
View File

@@ -1,85 +0,0 @@
require 'open-uri'
require 'yaml'
desc 'Build site into docs directory'
task :build do
jekyll_build
end
desc 'Update index.md and spec folder based on versions in _config.yml'
task :update do
config = YAML.load_file('_config.yml')
current_version = config['current_version']
versions = config['versions']
remove_all_specs(config['update'])
puts ''
puts 'Fetching configured spec versions:'
versions.each do |version|
spec = fetch_spec(version, config['update'])
if current_version == version
write_file('index.md', spec[:body], " (#{version})")
end
filename = File.join(config['update']['output_dir'], version)
write_file("#{filename}.md", spec[:body])
write_file("#{filename}.svg", spec[:diagram]) if spec[:diagram]
end
jekyll_build
end
def jekyll_build
puts 'Rebuilding output into docs directory...'
exec 'jekyll build --destination docs && touch docs/.nojekyll'
end
def write_file(file, content, comment = nil)
puts " - #{file}#{comment}"
File.write(file, content)
end
def fetch_spec(version, config)
document = get(build_file_url('document', version, config))
diagram = get(build_file_url('diagram', version, config))
if diagram
img_tag = config['img_tpl'].gsub('{{file}}', "#{version}.svg")
document.gsub!(/\A(.*\n=+\n)/, "\\1\n#{img_tag}\n")
end
title = document.split("\n", 2).first
body = config['body_tpl'].gsub('{{content}}', document)
.gsub('{{title}}', title)
.gsub('{{version}}', version)
{
version: version,
title: title,
body: body,
diagram: diagram
}
end
def build_file_url(file, version, config)
config['url_tpl']
.gsub('{{version}}', version)
.gsub('{{file}}', config['files'][file])
end
def get(url)
URI.parse(url).read
rescue OpenURI::HTTPError
nil
end
def remove_all_specs(config)
puts ''
puts 'Removing existing spec files:'
Dir["#{config['output_dir']}/*"].each do |file|
puts " #{file.gsub(File.dirname(__FILE__), '')}"
File.delete(file)
end
end

90
_assets/css/_base.scss
View File

@@ -1,90 +0,0 @@
html {
height: 100%;
}
body {
font-family: 'Open Sans', Helvetica, Arial, sans-serif;
font-size: 16px;
font-weight: 400;
line-height: 1.5;
color: #1a1a1a;
background-color: #fdfdfd;
}
h1, h2, h3, h4, h5, h6 {
font-family: 'Open Sans Condensed', Helvetica, Arial, sans-serif;
font-weight: 700;
color: #333;
}
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;
}
.content {
margin-top: 80px;
a {
word-break: break-word;
}
code {
background-color: rgba(27,31,35,0.05);
border-radius: 3px;
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 85%;
margin: 0;
padding: 0.3em 0.4em 0.1em 0.4em;
}
pre {
background-color: #f6f8fa;
border-radius: 3px;
line-height: 1.45;
padding: 16px;
}
pre > code {
background-color: transparent !important;
border-radius: none;
font-size: 90%;
padding: 0;
}
}
#menu {
.pure-menu-label {
color: #999;
border: none;
padding: 0.6em 0 0.6em 0.6em;
}
.links {
font-size: 50px;
position: absolute;
bottom: 10px;
left: 0px;
right: 0px;
text-align: center;
a {
color: #555;
padding: 0;
position: relative;
text-decoration: none;
&:hover {
color: #777;
}
}
}
}

248
_assets/css/_side-menu.scss
View File

@@ -1,248 +0,0 @@
body {
color: #777;
}
.pure-img-responsive {
max-width: 100%;
height: auto;
}
/*
Add transition to containers so they can push in and out.
*/
#layout,
#menu,
.menu-link {
-webkit-transition: all 0.2s ease-out;
-moz-transition: all 0.2s ease-out;
-ms-transition: all 0.2s ease-out;
-o-transition: all 0.2s ease-out;
transition: all 0.2s ease-out;
}
/*
This is the parent `<div>` that contains the menu and the content area.
*/
#layout {
position: relative;
left: 0;
padding-left: 0;
}
#layout.active #menu {
left: 150px;
width: 150px;
}
#layout.active .menu-link {
left: 150px;
}
/*
The content `<div>` is where all your content goes.
*/
.content {
margin: 0 auto;
padding: 0 2em;
max-width: 800px;
margin-bottom: 50px;
line-height: 1.6em;
}
.header {
margin: 0;
color: #333;
text-align: center;
padding: 2.5em 2em 0;
border-bottom: 1px solid #eee;
}
.header h1 {
margin: 0.2em 0;
font-size: 3em;
font-weight: 300;
}
.header h2 {
font-weight: 300;
color: #ccc;
padding: 0;
margin-top: 0;
}
.content-subhead {
margin: 50px 0 20px 0;
font-weight: 300;
color: #888;
}
/*
The `#menu` `<div>` is the parent `<div>` that contains the `.pure-menu` that
appears on the left side of the page.
*/
#menu {
margin-left: -150px; /* "#menu" width */
width: 150px;
position: fixed;
top: 0;
left: 0;
bottom: 0;
z-index: 1000; /* so the menu or its navicon stays above all content */
background: #191818;
overflow-y: auto;
-webkit-overflow-scrolling: touch;
}
/*
All anchors inside the menu should be styled like this.
*/
#menu a {
color: #999;
border: none;
padding: 0.6em 0 0.6em 0.6em;
}
/*
Remove all background/borders, since we are applying them to #menu.
*/
#menu .pure-menu,
#menu .pure-menu ul {
border: none;
background: transparent;
}
/*
Add that light border to separate items into groups.
*/
#menu .pure-menu ul,
#menu .pure-menu .menu-item-divided {
border-top: 1px solid #333;
}
/*
Change color of the anchor links on hover/focus.
*/
#menu .pure-menu li a:hover,
#menu .pure-menu li a:focus {
background: #333;
}
/*
This styles the selected menu item `<li>`.
*/
#menu .pure-menu-selected,
#menu .pure-menu-heading {
background: #1f8dd6;
}
/*
This styles a link within a selected menu item `<li>`.
*/
#menu .pure-menu-selected a {
color: #fff;
}
/*
This styles the menu heading.
*/
#menu .pure-menu-heading {
font-size: 110%;
color: #fff;
margin: 0;
}
/* -- Dynamic Button For Responsive Menu -------------------------------------*/
/*
The button to open/close the Menu is custom-made and not part of Pure. Here's
how it works:
*/
/*
`.menu-link` represents the responsive menu toggle that shows/hides on
small screens.
*/
.menu-link {
position: fixed;
display: block; /* show this only on small screens */
top: 0;
left: 0; /* "#menu width" */
background: #000;
background: rgba(0,0,0,0.7);
font-size: 10px; /* change this value to increase/decrease button size */
z-index: 10;
width: 2em;
height: auto;
padding: 2.1em 1.6em;
}
.menu-link:hover,
.menu-link:focus {
background: #000;
}
.menu-link span {
position: relative;
display: block;
}
.menu-link span,
.menu-link span:before,
.menu-link span:after {
background-color: #fff;
width: 100%;
height: 0.2em;
}
.menu-link span:before,
.menu-link span:after {
position: absolute;
margin-top: -0.6em;
content: " ";
}
.menu-link span:after {
margin-top: 0.6em;
}
/* -- Responsive Styles (Media Queries) ------------------------------------- */
/*
Hides the menu at `48em`, but modify this based on your app's needs.
*/
@media (min-width: 48em) {
.header,
.content {
padding-left: 2em;
padding-right: 2em;
}
#layout {
padding-left: 150px; /* left col width "#menu" */
left: 0;
}
#menu {
left: 150px;
}
.menu-link {
position: fixed;
left: 150px;
display: none;
}
#layout.active .menu-link {
left: 150px;
}
}
@media (max-width: 48em) {
/* Only apply this when the window is small. Otherwise, the following
case results in extra padding on the left:
* Make the window small.
* Tap the menu to trigger the active state.
* Make the window large again.
*/
#layout.active {
position: relative;
left: 150px;
}
}

2
_assets/css/main.scss
View File

@@ -1,2 +0,0 @@
@import "side-menu";
@import "base";

1
_assets/js/main.js
View File

@@ -1 +0,0 @@
// = require ui

44
_assets/js/ui.js
View File

@@ -1,44 +0,0 @@
(function (window, document) {
var layout = document.getElementById('layout');
var menu = document.getElementById('menu');
var menuLink = document.getElementById('menuLink');
var content = document.getElementById('main');
function toggleClass (element, className) {
var classes = element.className.split(/\s+/);
var length = classes.length;
var i = 0;
for (; i < length; i++) {
if (classes[i] === className) {
classes.splice(i, 1);
break;
}
}
// The className is not found
if (length === classes.length) {
classes.push(className);
}
element.className = classes.join(' ');
}
function toggleAll (e) {
var active = 'active';
e.preventDefault();
toggleClass(layout, active);
toggleClass(menu, active);
toggleClass(menuLink, active);
}
menuLink.onclick = function (e) {
toggleAll(e);
};
content.onclick = function (e) {
if (menu.className.indexOf('active') !== -1) {
toggleAll(e);
}
};
}(this, this.document));

61
_config.yml
View File

@@ -1,61 +0,0 @@
title: Git Common Flow
description: >
An attempt to gather a sensible selection of the most common usage patterns of
git into a single and concise specification.
author: Jim Myhrberg
hostname: commonflow.org
url: https://commonflow.org
repo_url: https://github.com/jimeh/common-flow
current_version: 1.0.0-rc.5
versions:
- 1.0.0-rc.5
- 1.0.0-rc.4
- 1.0.0-rc.3
- 1.0.0-rc.2
- 1.0.0-rc.1
exclude:
- Gemfile
- Gemfile.lock
- Rakefile
- README.md
update:
body_tpl: |
---
title: {{title}}
version: {{version}}
---
{{content}}
url_tpl: "https://github.com/jimeh/common-flow/raw/{{version}}/{{file}}"
img_tpl: "<img src=\"/spec/{{file}}\" width=\"100%\" />"
output_dir: "spec"
files:
document: common-flow.md
diagram: common-flow.svg
plugins:
- jekyll-assets
- jekyll-pants
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-tidy
defaults:
-
scope:
path: ""
values:
layout: "default"
assets:
digest: true
compress:
css: true
js: true
img: true
markdown: kramdown
kramdown:
input: Pantsdown # disable smart quotes typographic symbols

54
_layouts/default.html
View File

@@ -1,54 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
{% css main %}
{% seo %}
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
{% for version in site.versions %}
{% assign expected = "spec/" | append: version | append: ".md" %}
{% assign found = site.pages | where: "path", expected | first %}
{% assign selected = "" %}
{% if version == page.version %}
{% assign selected = " pure-menu-selected" %}
{% endif %}
{% if found %}
<li class="pure-menu-item version-{{ version }}{{ selected }}">
<a href="{{ found.url }}" class="pure-menu-link">{{ version }}</a>
</li>
{% endif %}
{% endfor %}
</ul>
</div>
<div class="links">
<a href="{{ site.repo_url }}">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
{{ content }}
</div>
</div>
</div>
{% js main %}
</body>
</html>

12
astro.config.mjs Normal file
View File

@@ -0,0 +1,12 @@
import { defineConfig } from "astro/config";
import tailwindcss from "@tailwindcss/vite";
import sitemap from "@astrojs/sitemap";
export default defineConfig({
site: "https://commonflow.org",
outDir: "./docs",
integrations: [sitemap()],
vite: {
plugins: [tailwindcss()],
},
});

87
docs/404.html
View File

@@ -1,72 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/404/"><title>Page Not Found | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Page Not Found | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/404/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Page Not Found | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css">
<html> <style>.not-found[data-astro-cid-zetdm5md]{text-align:center;padding-top:4rem}.not-found[data-astro-cid-zetdm5md] h1[data-astro-cid-zetdm5md]{font-size:6rem;margin-bottom:.5rem;color:#999}.dark[data-astro-cid-zetdm5md] .not-found[data-astro-cid-zetdm5md] h1[data-astro-cid-zetdm5md]{color:#666}.not-found[data-astro-cid-zetdm5md] p[data-astro-cid-zetdm5md]{font-size:1.25rem;margin-bottom:1rem}.not-found[data-astro-cid-zetdm5md] a[data-astro-cid-zetdm5md]{color:#1f8dd6;text-decoration:none}.not-found[data-astro-cid-zetdm5md] a[data-astro-cid-zetdm5md]:hover{text-decoration:underline}.dark[data-astro-cid-zetdm5md] .not-found[data-astro-cid-zetdm5md] a[data-astro-cid-zetdm5md]{color:#4da6e8}
<head> </style></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
<meta charset="utf-8"> 9.504.5.092.682-.217.682-.483
<meta http-equiv="X-UA-Compatible" content="IE=edge"> 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
<meta name="viewport" content="width=device-width, initial-scale=1"> 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'> 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous"> 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"> 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css"> 1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
<!-- Begin Jekyll SEO tag v2.2.3 --> 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
<title>404 Page Not Found | Git Common Flow</title> 2.688 0 3.848-2.339 4.695-4.566
<meta property="og:title" content="404 Page Not Found" /> 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
<meta name="author" content="Jim Myhrberg" /> 2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
<meta property="og:locale" content="en_US" /> 6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <div class="not-found" data-astro-cid-zetdm5md> <h1 data-astro-cid-zetdm5md>404</h1> <p data-astro-cid-zetdm5md>Page not found.</p> <p data-astro-cid-zetdm5md> <a href="/" data-astro-cid-zetdm5md>Go to the homepage</a> </p> </div> </div> </div> </div> </body></html>
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/404.html" />
<meta property="og:url" content="https://commonflow.org/404.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"404 Page Not Found","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/404.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.5">
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<div class="header">
<h1>404</h1>
<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

1
docs/CNAME
View File

@@ -1 +0,0 @@
commonflow.org

1
docs/_astro/index.BMC0NJ9O.css Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css
View File

@@ -1 +0,0 @@
body{color:#777}.pure-img-responsive{max-width:100%;height:auto}#layout,#menu,.menu-link{-webkit-transition:all 0.2s ease-out;-moz-transition:all 0.2s ease-out;-ms-transition:all 0.2s ease-out;-o-transition:all 0.2s ease-out;transition:all 0.2s ease-out}#layout{position:relative;left:0;padding-left:0}#layout.active #menu{left:150px;width:150px}#layout.active .menu-link{left:150px}.content{margin:0 auto;padding:0 2em;max-width:800px;margin-bottom:50px;line-height:1.6em}.header{margin:0;color:#333;text-align:center;padding:2.5em 2em 0;border-bottom:1px solid #eee}.header h1{margin:0.2em 0;font-size:3em;font-weight:300}.header h2{font-weight:300;color:#ccc;padding:0;margin-top:0}.content-subhead{margin:50px 0 20px 0;font-weight:300;color:#888}#menu{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}#menu a{color:#999;border:none;padding:0.6em 0 0.6em 0.6em}#menu .pure-menu,#menu .pure-menu ul{border:none;background:transparent}#menu .pure-menu ul,#menu .pure-menu .menu-item-divided{border-top:1px solid #333}#menu .pure-menu li a:hover,#menu .pure-menu li a:focus{background:#333}#menu .pure-menu-selected,#menu .pure-menu-heading{background:#1f8dd6}#menu .pure-menu-selected a{color:#fff}#menu .pure-menu-heading{font-size:110%;color:#fff;margin:0}.menu-link{position:fixed;display:block;top:0;left:0;background:#000;background:rgba(0,0,0,0.7);font-size:10px;z-index:10;width:2em;height:auto;padding:2.1em 1.6em}.menu-link:hover,.menu-link:focus{background:#000}.menu-link span{position:relative;display:block}.menu-link span,.menu-link span:before,.menu-link span:after{background-color:#fff;width:100%;height:0.2em}.menu-link span:before,.menu-link span:after{position:absolute;margin-top:-0.6em;content:" "}.menu-link span:after{margin-top:0.6em}@media (min-width: 48em){.header,.content{padding-left:2em;padding-right:2em}#layout{padding-left:150px;left:0}#menu{left:150px}.menu-link{position:fixed;left:150px;display:none}#layout.active .menu-link{left:150px}}@media (max-width: 48em){#layout.active{position:relative;left:150px}}html{height:100%}body{font-family:'Open Sans', Helvetica, Arial, sans-serif;font-size:16px;font-weight:400;line-height:1.5;color:#1a1a1a;background-color:#fdfdfd}h1,h2,h3,h4,h5,h6{font-family:'Open Sans Condensed', Helvetica, Arial, sans-serif;font-weight:700;color:#333}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}.content{margin-top:80px}.content a{word-break:break-word}.content code{background-color:rgba(27,31,35,0.05);border-radius:3px;font-family:"SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;font-size:90%;margin:0;padding:0.2em}#menu .pure-menu-label{color:#999;border:none;padding:0.6em 0 0.6em 0.6em}

1
docs/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.css
View File

@@ -1 +0,0 @@
body{color:#777}.pure-img-responsive{max-width:100%;height:auto}#layout,#menu,.menu-link{-webkit-transition:all 0.2s ease-out;-moz-transition:all 0.2s ease-out;-ms-transition:all 0.2s ease-out;-o-transition:all 0.2s ease-out;transition:all 0.2s ease-out}#layout{position:relative;left:0;padding-left:0}#layout.active #menu{left:150px;width:150px}#layout.active .menu-link{left:150px}.content{margin:0 auto;padding:0 2em;max-width:800px;margin-bottom:50px;line-height:1.6em}.header{margin:0;color:#333;text-align:center;padding:2.5em 2em 0;border-bottom:1px solid #eee}.header h1{margin:0.2em 0;font-size:3em;font-weight:300}.header h2{font-weight:300;color:#ccc;padding:0;margin-top:0}.content-subhead{margin:50px 0 20px 0;font-weight:300;color:#888}#menu{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}#menu a{color:#999;border:none;padding:0.6em 0 0.6em 0.6em}#menu .pure-menu,#menu .pure-menu ul{border:none;background:transparent}#menu .pure-menu ul,#menu .pure-menu .menu-item-divided{border-top:1px solid #333}#menu .pure-menu li a:hover,#menu .pure-menu li a:focus{background:#333}#menu .pure-menu-selected,#menu .pure-menu-heading{background:#1f8dd6}#menu .pure-menu-selected a{color:#fff}#menu .pure-menu-heading{font-size:110%;color:#fff;margin:0}.menu-link{position:fixed;display:block;top:0;left:0;background:#000;background:rgba(0,0,0,0.7);font-size:10px;z-index:10;width:2em;height:auto;padding:2.1em 1.6em}.menu-link:hover,.menu-link:focus{background:#000}.menu-link span{position:relative;display:block}.menu-link span,.menu-link span:before,.menu-link span:after{background-color:#fff;width:100%;height:0.2em}.menu-link span:before,.menu-link span:after{position:absolute;margin-top:-0.6em;content:" "}.menu-link span:after{margin-top:0.6em}@media (min-width: 48em){.header,.content{padding-left:2em;padding-right:2em}#layout{padding-left:150px;left:0}#menu{left:150px}.menu-link{position:fixed;left:150px;display:none}#layout.active .menu-link{left:150px}}@media (max-width: 48em){#layout.active{position:relative;left:150px}}html{height:100%}body{font-family:'Open Sans', Helvetica, Arial, sans-serif;font-size:16px;font-weight:400;line-height:1.5;color:#1a1a1a;background-color:#fdfdfd}h1,h2,h3,h4,h5,h6{font-family:'Open Sans Condensed', Helvetica, Arial, sans-serif;font-weight:700;color:#333}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}.content{margin-top:80px}.content a{word-break:break-word}.content code{background-color:rgba(27,31,35,0.05);border-radius:3px;font-family:"SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;font-size:90%;margin:0;padding:0.2em}#menu .pure-menu-label{color:#999;border:none;padding:0.6em 0 0.6em 0.6em}#menu .links{font-size:50px;position:absolute;bottom:10px;left:0px;right:0px;text-align:center}#menu .links a{color:#555;padding:0;position:relative;text-decoration:none}#menu .links a:hover{color:#777}

1
docs/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js
View File

@@ -1 +0,0 @@
!function(e,n){function t(e,n){for(var t=e.className.split(/\s+/),i=t.length,c=0;c<i;c++)if(t[c]===n){t.splice(c,1);break}i===t.length&&t.push(n),e.className=t.join(" ")}function i(e){var n="active";e.preventDefault(),t(c,n),t(a,n),t(l,n)}var c=n.getElementById("layout"),a=n.getElementById("menu"),l=n.getElementById("menuLink"),m=n.getElementById("main");l.onclick=function(e){i(e)},m.onclick=function(e){-1!==a.className.indexOf("active")&&i(e)}}(0,this.document);

1
docs/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css
View File

@@ -1 +0,0 @@
body{color:#777}.pure-img-responsive{max-width:100%;height:auto}#layout,#menu,.menu-link{-webkit-transition:all 0.2s ease-out;-moz-transition:all 0.2s ease-out;-ms-transition:all 0.2s ease-out;-o-transition:all 0.2s ease-out;transition:all 0.2s ease-out}#layout{position:relative;left:0;padding-left:0}#layout.active #menu{left:150px;width:150px}#layout.active .menu-link{left:150px}.content{margin:0 auto;padding:0 2em;max-width:800px;margin-bottom:50px;line-height:1.6em}.header{margin:0;color:#333;text-align:center;padding:2.5em 2em 0;border-bottom:1px solid #eee}.header h1{margin:0.2em 0;font-size:3em;font-weight:300}.header h2{font-weight:300;color:#ccc;padding:0;margin-top:0}.content-subhead{margin:50px 0 20px 0;font-weight:300;color:#888}#menu{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}#menu a{color:#999;border:none;padding:0.6em 0 0.6em 0.6em}#menu .pure-menu,#menu .pure-menu ul{border:none;background:transparent}#menu .pure-menu ul,#menu .pure-menu .menu-item-divided{border-top:1px solid #333}#menu .pure-menu li a:hover,#menu .pure-menu li a:focus{background:#333}#menu .pure-menu-selected,#menu .pure-menu-heading{background:#1f8dd6}#menu .pure-menu-selected a{color:#fff}#menu .pure-menu-heading{font-size:110%;color:#fff;margin:0}.menu-link{position:fixed;display:block;top:0;left:0;background:#000;background:rgba(0,0,0,0.7);font-size:10px;z-index:10;width:2em;height:auto;padding:2.1em 1.6em}.menu-link:hover,.menu-link:focus{background:#000}.menu-link span{position:relative;display:block}.menu-link span,.menu-link span:before,.menu-link span:after{background-color:#fff;width:100%;height:0.2em}.menu-link span:before,.menu-link span:after{position:absolute;margin-top:-0.6em;content:" "}.menu-link span:after{margin-top:0.6em}@media (min-width: 48em){.header,.content{padding-left:2em;padding-right:2em}#layout{padding-left:150px;left:0}#menu{left:150px}.menu-link{position:fixed;left:150px;display:none}#layout.active .menu-link{left:150px}}@media (max-width: 48em){#layout.active{position:relative;left:150px}}html{height:100%}body{font-family:'Open Sans', Helvetica, Arial, sans-serif;font-size:16px;font-weight:400;line-height:1.5;color:#1a1a1a;background-color:#fdfdfd}h1,h2,h3,h4,h5,h6{font-family:'Open Sans Condensed', Helvetica, Arial, sans-serif;font-weight:700;color:#333}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}.content{margin-top:80px}.content a{word-break:break-word}.content code{background-color:rgba(27,31,35,0.05);border-radius:3px;font-family:"SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;font-size:85%;margin:0;padding:0.3em 0.4em 0.1em 0.4em}.content pre{background-color:#f6f8fa;border-radius:3px;line-height:1.45;padding:16px}.content pre>code{background-color:transparent !important;border-radius:none;font-size:90%;padding:0}#menu .pure-menu-label{color:#999;border:none;padding:0.6em 0 0.6em 0.6em}#menu .links{font-size:50px;position:absolute;bottom:10px;left:0px;right:0px;text-align:center}#menu .links a{color:#555;padding:0;position:relative;text-decoration:none}#menu .links a:hover{color:#777}

795
docs/index.html
View File

@@ -1,425 +1,370 @@
<!DOCTYPE html> <!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/"><title>Git Common-Flow 1.0.0-rc.5 | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Git Common-Flow 1.0.0-rc.5 | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Git Common-Flow 1.0.0-rc.5 | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css"></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item selected" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
<html> 9.504.5.092.682-.217.682-.483
<head> 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
<meta charset="utf-8"> 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
<meta http-equiv="X-UA-Compatible" content="IE=edge"> 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
<meta name="viewport" content="width=device-width, initial-scale=1"> 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'> 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous"> 1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"> 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css"> 2.688 0 3.848-2.339 4.695-4.566
<!-- Begin Jekyll SEO tag v2.2.3 --> 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
<title>Git Common-Flow 1.0.0-rc.5 | Git Common Flow</title> 2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.5" /> 6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <article class="spec-content"> <h1 id="git-common-flow-100-rc5">Git Common-Flow 1.0.0-rc.5</h1>
<meta name="author" content="Jim Myhrberg" /> <img src="/spec/1.0.0-rc.5.svg" alt="Git Common-Flow 1.0.0-rc.5 diagram" width="100%">
<meta property="og:locale" content="en_US" /> <h2 id="introduction">Introduction</h2>
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." /> <p>Common-Flow is an attempt to gather a sensible selection of the most common
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." /> usage patterns of git into a single and concise specification. It is based on
<link rel="canonical" href="https://commonflow.org/" /> the <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
<meta property="og:url" content="https://commonflow.org/" /> of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
<meta property="og:site_name" content="Git Common Flow" /> into account how a lot of open source projects most commonly use git.</p>
<script type="application/ld+json"> <p>In short, Common-Flow is essentially GitHub Flow with the addition of versioned
{"@context":"http://schema.org","@type":"WebSite","name":"Git Common Flow","headline":"Git Common-Flow 1.0.0-rc.5","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/"} releases, optional release branches, and without the requirement to deploy to
</script> production all the time.</p>
<!-- End Jekyll SEO tag --> <h2 id="summary">Summary</h2>
</head> <ul>
<body> <li>The “master” branch is the mainline branch with latest changes, and must not
<div id="layout"> be broken.</li>
<a href="#menu" id="menuLink" class="menu-link"> <li>Changes (features, bugfixes, etc.) are done on “change branches” created from
<span></span> the master branch.</li>
</a> <li>Rebase change branches <a href="https://i.imgur.com/1RS8x2d.png">early and often</a>.</li>
<div id="menu"> <li>When a change branch is stable and ready, it is merged back in to master.</li>
<div class="pure-menu"> <li>A release is just a git tag who’s name is the exact release version string
<ul class="pure-menu-list"> (e.g. “2.11.4”).</li>
<li class="pure-menu-item"> <li>Release branches can be used to avoid change freezes on master. They are not
<div class="pure-menu-label">Versions:</div> required, instead they are available if you need them.</li>
</li> </ul>
<li class="pure-menu-item version-1.0.0-rc.5 pure-menu-selected"> <h2 id="terminology">Terminology</h2>
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a> <ul>
</li> <li><strong>Master Branch</strong> - Must be named “master”, must always have passing tests,
<li class="pure-menu-item version-1.0.0-rc.4"> and is not guaranteed to always work in production environments.</li>
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a> <li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
</li> bug fix, etc.</li>
<li class="pure-menu-item version-1.0.0-rc.3"> <li><strong>Source Branch</strong> - The branch that a change branch was created from. New
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a> changes in the source branch should be incorporated into the change branch via
</li> rebasing.</li>
<li class="pure-menu-item version-1.0.0-rc.2"> <li><strong>Merge Target</strong> - A branch that is the intended merge target for a change
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a> branch. Typically the merge target branch will be the same as the source
</li> branch.</li>
<li class="pure-menu-item version-1.0.0-rc.1"> <li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a> its merge target, allowing others to review, discuss and approve the changes.</li>
</li> <li><strong>Release</strong> - May be considered safe to use in production environments. Is
</ul> effectively just a git tag named after the version of the release.</li>
</div> <li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
<div class="links"> also for long-term maintenance of older version.</li>
<a href="https://github.com/jimeh/common-flow"> </ul>
<i class="fa fa-github" aria-hidden="true"></i> <h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
</a> <p>The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
</div> “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be
</div> interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<div id="main"> <ol>
<div class="content"> <li>TL;DR
<h1 id="git-common-flow-100-rc5">Git Common-Flow 1.0.0-rc.5</h1> <ol>
<p><img src="/spec/1.0.0-rc.5.svg" width="100%" /></p> <li>Do not break the master branch.</li>
<h2 id="introduction">Introduction</h2> <li>A release is a git tag.</li>
<p>Common-Flow is an attempt to gather a sensible selection of the most common </ol>
usage patterns of git into a single and concise specification. It is based on </li>
the <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a> <li>The Master Branch
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking <ol>
into account how a lot of open source projects most commonly use git.</p> <li>A branch named “master” MUST exist and it MUST be referred to as the
<p>In short, Common-Flow is essentially GitHub Flow with the addition of versioned “master branch”.</li>
releases, optional release branches, and without the requirement to deploy to <li>The master branch MUST always be in a non-broken state with its test
production all the time.</p> suite passing.</li>
<h2 id="summary">Summary</h2> <li>The master branch IS NOT guaranteed to always work in production
<ul> environments. Despite test suites passing it may at times contain
<li>The "master" branch is the mainline branch with latest changes, and must not unfinished work. Only releases may be considered safe for production use.</li>
be broken.</li> <li>The master branch SHOULD always be in a “as near as possibly ready for
<li>Changes (features, bugfixes, etc.) are done on "change branches" created from release/production” state to reduce any friction with creating a new
the master branch.</li> release.</li>
<li>Rebase change branches <a href="https://i.imgur.com/1RS8x2d.png">early and often</a>.</li> </ol>
<li>When a change branch is stable and ready, it is merged back in to master.</li> </li>
<li>A release is just a git tag who's name is the exact release version string <li>Change Branches
(e.g. "2.11.4").</li> <ol>
<li>Release branches can be used to avoid change freezes on master. They are not <li>Each change (feature, bugfix, etc.) MUST be performed on separate
required, instead they are available if you need them.</li> branches that SHOULD be referred to as “change branches”.</li>
</ul> <li>All change branches MUST have descriptive names.</li>
<h2 id="terminology">Terminology</h2> <li>It is RECOMMENDED that you commit often locally, and that you try and
<ul> keep the commits reasonably structured to avoid a messy and confusing git
<li><strong>Master Branch</strong> - Must be named "master", must always have passing tests, history.</li>
and is not guaranteed to always work in production environments.</li> <li>You SHOULD regularly push your work to the same named branch on the
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a remote server.</li>
bug fix, etc.</li> <li>You SHOULD create separate change branches for each distinctly different
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New change. You SHOULD NOT include multiple unrelated changes into a single
changes in the source branch should be incorporated into the change branch via change branch.</li>
rebasing.</li> <li>When a change branch is created, the branch that it is created from
<li><strong>Merge Target</strong> - A branch that is the intended merge target for a change SHOULD be referred to as the “source branch”. Each change branch also
branch. Typically the merge target branch will be the same as the source needs a designated “merge target” branch, typically this will be the same
branch.</li> as the source branch.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to <li>Change branches MUST be regularly updated with any changes from their
its merge target, allowing others to review, discuss and approve the changes.</li> source branch. This MUST be done by rebasing the change branch on top of
<li><strong>Release</strong> - May be considered safe to use in production environments. Is the source branch.</li>
effectively just a git tag named after the version of the release.</li> <li>After updating a change branch from its source branch you MUST push the
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and change branch to the remote server. Due to the nature of rebasing, you
also for long-term maintenance of older version.</li> will be required to do a force push, and you MUST use the
</ul> “—force-with-lease” git push option when doing so instead of the regular
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2> “—force”.</li>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", <li>If there is a truly valid technical reason to not use rebase when
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be updating change branches, then you can update change branches via merge
interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p> instead of rebase. The decision to use merge MUST only be taken after all
<ol> possible options to use rebase have been tried and failed. People not
<li>TL;DR understanding how to use rebase is NOT a valid reason to use merge. If
<ol> you do decide to use merge instead of rebase, you MUST NOT use a mixture
<li>Do not break the master branch.</li> of both methods, pick one and stick to it.</li>
<li>A release is a git tag.</li> </ol>
</ol> </li>
</li> <li>Pull Requests
<li>The Master Branch <ol>
<ol> <li>To merge a change branch into its merge target, you MUST open a “pull
<li>A branch named "master" MUST exist and it MUST be referred to as the request” (or equivalent).</li>
"master branch".</li> <li>The purpose of a pull request is to allow others to review your changes
<li>The master branch MUST always be in a non-broken state with its test and give feedback. You can then fix any issues, complaints, and more that
suite passing.</li> might arise, and then let people review again.</li>
<li>The master branch IS NOT guaranteed to always work in production <li>Before creating a pull request, it is RECOMMENDED that you consider the
environments. Despite test suites passing it may at times contain state of your change branch’s commit history. If it is messy and
unfinished work. Only releases may be considered safe for production use.</li> confusing, it might be a good idea to rebase your branch with “git rebase
<li>The master branch SHOULD always be in a "as near as possibly ready for -i” to present a cleaner and easier to follow commit history for your
release/production" state to reduce any friction with creating a new reviewers.</li>
release.</li> <li>A pull request MUST only be merged when the change branch is up-to-date
</ol> with its source branch, the test suite is passing, and you and others are
</li> happy with the change. This is especially important if the merge target
<li>Change Branches is the master branch.</li>
<ol> <li>To get feedback, help, or generally just discuss a change branch with
<li>Each change (feature, bugfix, etc.) MUST be performed on separate others, it is RECOMMENDED you create a pull request and discuss the
branches that SHOULD be referred to as "change branches".</li> changes with others there. This leaves a clear and visible history of
<li>All change branches MUST have descriptive names.</li> how, when, and why the code looks and behaves the way it does.</li>
<li>It is RECOMMENDED that you commit often locally, and that you try and </ol>
keep the commits reasonably structured to avoid a messy and confusing git </li>
history.</li> <li>Versioning
<li>You SHOULD regularly push your work to the same named branch on the <ol>
remote server.</li> <li>A “version string” is a typically mostly numeric string that identifies a
<li>You SHOULD create separate change branches for each distinctly different specific version of a project. The version string itself MUST NOT have a
change. You SHOULD NOT include multiple unrelated changes into a single “v” prefix, but the version string can be displayed with a “v” prefix to
change branch.</li> indicate it is a version that is being referred to.</li>
<li>When a change branch is created, the branch that it is created from <li>The source of truth for a project’s version MUST be a git tag with a name
SHOULD be referred to as the "source branch". Each change branch also based on the version string. This kind of tag MUST be referred to as a
needs a designated "merge target" branch, typically this will be the same “release tag”.</li>
as the source branch.</li> <li>It is OPTIONAL, but RECOMMENDED to also keep the version string
<li>Change branches MUST be regularly updated with any changes from their hard-coded somewhere in the project code-base.</li>
source branch. This MUST be done by rebasing the change branch on top of <li>If you hard-code the version string into the code-base, it is RECOMMENDED
the source branch.</li> that you do so in a file called “VERSION” located in the root of the
<li>After updating a change branch from its source branch you MUST push the project. But be mindful of the conventions of your programming language
change branch to the remote server. Due to the nature of rebasing, you and community when choosing if, where and how to hard-code the version
will be required to do a force push, and you MUST use the string.</li>
"--force-with-lease" git push option when doing so instead of the regular <li>If you are using a “VERSION” file in the root of the project, this file
"--force".</li> MUST only contain the exact version string, meaning it MUST NOT have a
<li>If there is a truly valid technical reason to not use rebase when “v” prefix. For example “v2.11.4” is bad, and “2.11.4” is good.</li>
updating change branches, then you can update change branches via merge <li>It is OPTIONAL, but RECOMMENDED that that the version string follows
instead of rebase. The decision to use merge MUST only be taken after all Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
possible options to use rebase have been tried and failed. People not </ol>
understanding how to use rebase is NOT a valid reason to use merge. If </li>
you do decide to use merge instead of rebase, you MUST NOT use a mixture <li>Releases
of both methods, pick one and stick to it.</li> <ol>
</ol> <li>To create a new release, you MUST create a git tag named as the exact
</li> version string of the release. This kind of tag MUST be referred to as a
<li>Pull Requests “release tag”.</li>
<ol> <li>The release tag name can OPTIONALLY be prefixed with “v”. For example the
<li>To merge a change branch into its merge target, you MUST open a "pull tag name can be either “2.11.4” or “v2.11.4”. It is however RECOMMENDED
request" (or equivalent).</li> that you do not use a “v” prefix. You MUST NOT use a mixture of “v”
<li>The purpose of a pull request is to allow others to review your changes prefixed and non-prefixed tags. Pick one form and stick to it.</li>
and give feedback. You can then fix any issues, complaints, and more that <li>If the version string is hard-coded into the code-base, you MUST create a
might arise, and then let people review again.</li> “version bump” commit which changes the hard-coded version string of the
<li>Before creating a pull request, it is RECOMMENDED that you consider the project.</li>
state of your change branch's commit history. If it is messy and <li>When using version bump commits, the release tag MUST be placed on the
confusing, it might be a good idea to rebase your branch with "git rebase version bump commit.</li>
-i" to present a cleaner and easier to follow commit history for your <li>If you are not using a release branch, then the release tag, and if
reviewers.</li> relevant the version bump commit, MUST be created directly on the master
<li>A pull request MUST only be merged when the change branch is up-to-date branch.</li>
with its source branch, the test suite is passing, and you and others are <li>The version bump commit SHOULD have a commit message title of “Bump
happy with the change. This is especially important if the merge target version to VERSION”. For example, if the new version string is “2.11.4”,
is the master branch.</li> the first line of the commit message SHOULD read: “Bump version to
<li>To get feedback, help, or generally just discuss a change branch with 2.11.4”</li>
others, it is RECOMMENDED you create a pull request and discuss the <li>It is RECOMMENDED that release tags are lightweight tags, but you can
changes with others there. This leaves a clear and visible history of OPTIONALLY use annotated tags if you want to include changelog
how, when, and why the code looks and behaves the way it does.</li> information in the release tag itself.</li>
</ol> <li>If you use annotated release tags, the first line of the annotation
</li> SHOULD read “Release VERSION”. For example for version “2.11.4” the first
<li>Versioning line of the tag annotation SHOULD read “Release 2.11.4”. The second line
<ol> MUST be blank, and the changelog MUST start on the third line.</li>
<li>A "version string" is a typically mostly numeric string that identifies a </ol>
specific version of a project. The version string itself MUST NOT have a </li>
"v" prefix, but the version string can be displayed with a "v" prefix to <li>Short-Term Release Branches
indicate it is a version that is being referred to.</li> <ol>
<li>The source of truth for a project's version MUST be a git tag with a name <li>Any branch that has a name starting with “release-” SHOULD be referred to
based on the version string. This kind of tag MUST be referred to as a as a “release branch”.</li>
"release tag".</li> <li>Any release branch which has a name ending with a specific version
<li>It is OPTIONAL, but RECOMMENDED to also keep the version string string, MUST be referred to as a “short-term release branch”.</li>
hard-coded somewhere in the project code-base.</li> <li>Use of short-term release branches are OPTIONAL, and intended to be used
<li>If you hard-code the version string into the code-base, it is RECOMMENDED to create a specific versioned release.</li>
that you do so in a file called "VERSION" located in the root of the <li>A short-term release branch is RECOMMENDED if there is a lengthy
project. But be mindful of the conventions of your programming language pre-release verification process to avoid a code freeze on the master
and community when choosing if, where and how to hard-code the version branch.</li>
string.</li> <li>Short-term release branches MUST have a name of “release-VERSION”. For
<li>If you are using a "VERSION" file in the root of the project, this file example for version “2.11.4” the release branch name MUST be
MUST only contain the exact version string, meaning it MUST NOT have a “release-2.11.4”.</li>
"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.</li> <li>When using a short-term release branch to create a release, the release
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows tag and if used, version bump commit, MUST be placed directly on the
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li> short-term release branch itself.</li>
</ol> <li>Only very minor changes should be performed on a short-term release
</li> branch directly. Any larger changes SHOULD be done in the master branch,
<li>Releases and SHOULD be pulled into the release branch by rebasing it on top of the
<ol> master branch the same way a change branch pulls in updates from its
<li>To create a new release, you MUST create a git tag named as the exact source branch.</li>
version string of the release. This kind of tag MUST be referred to as a <li>After a release tag has been created, the release branch MUST be merged
"release tag".</li> back into its source branch and then deleted. Typically the source branch
<li>The release tag name can OPTIONALLY be prefixed with "v". For example the will be the master branch.</li>
tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED </ol>
that you do not use a "v" prefix. You MUST NOT use a mixture of "v" </li>
prefixed and non-prefixed tags. Pick one form and stick to it.</li> <li>Long-term Release Branches
<li>If the version string is hard-coded into the code-base, you MUST create a <ol>
"version bump" commit which changes the hard-coded version string of the <li>Any release branch which has a name ending with a non-specific version
project.</li> string, MUST be referred to as a “long-term release branch”. For example
<li>When using version bump commits, the release tag MUST be placed on the “release-2.11” is a long-term release branch, while “release-2.11.4” is a
version bump commit.</li> short-term release branch.</li>
<li>If you are not using a release branch, then the release tag, and if <li>Use of long-term release branches are OPTIONAL, and intended for work on
relevant the version bump commit, MUST be created directly on the master versions which are not currently part of the master branch. Typically
branch.</li> this is useful when you need to create a new maintenance release for a
<li>The version bump commit SHOULD have a commit message title of "Bump older version.</li>
version to VERSION". For example, if the new version string is "2.11.4", <li>A long-term release branch MUST have a name with a non-specific version
the first line of the commit message SHOULD read: "Bump version to number. For example a long-term release branch for creating new 2.9.x
2.11.4"</li> releases MUST be named “release-2.9”.</li>
<li>It is RECOMMENDED that release tags are lightweight tags, but you can <li>Long-term release branches for maintenance releases of older versions
OPTIONALLY use annotated tags if you want to include changelog MUST be created from the relevant release tag. For example if the master
information in the release tag itself.</li> branch is on version 2.11.4 and there is a security fix for all 2.9.x
<li>If you use annotated release tags, the first line of the annotation releases, the latest of which is “2.9.7”. Create a new branch called
SHOULD read "Release VERSION". For example for version "2.11.4" the first “release-2.9” from the “2.9.7” release tag. The security fix release will
line of the tag annotation SHOULD read "Release 2.11.4". The second line then end up being version “2.9.8”.</li>
MUST be blank, and the changelog MUST start on the third line.</li> <li>To create a new release from a long-term release branch, you MUST follow
</ol> the same process as a release from the master branch, except the
</li> long-term release branch takes the place of the master branch.</li>
<li>Short-Term Release Branches <li>A long-term release branch should be treated with the same respect as the
<ol> master branch. It is effectively the master branch for the release series
<li>Any branch that has a name starting with "release-" SHOULD be referred to in question. Meaning it MUST always be in a non-broken state, MUST NOT be
as a "release branch".</li> force pushed to, etc.</li>
<li>Any release branch which has a name ending with a specific version </ol>
string, MUST be referred to as a "short-term release branch".</li> </li>
<li>Use of short-term release branches are OPTIONAL, and intended to be used <li>Bug Fixes &#x26; Rollback
to create a specific versioned release.</li> <ol>
<li>A short-term release branch is RECOMMENDED if there is a lengthy <li>You MUST NOT under any circumstances force push to the master branch or
pre-release verification process to avoid a code freeze on the master to long-term release branches.</li>
branch.</li> <li>If a change branch which has been merged into the master branch is found
<li>Short-term release branches MUST have a name of "release-VERSION". For to have a bug in it, the bug fix work MUST be done as a new separate
example for version "2.11.4" the release branch name MUST be change branch and MUST follow the same workflow as any other change
"release-2.11.4".</li> branch.</li>
<li>When using a short-term release branch to create a release, the release <li>If a change branch is wrongfully merged into master, or for any other
tag and if used, version bump commit, MUST be placed directly on the reason the merge must be undone, you MUST undo the merge by reverting the
short-term release branch itself.</li> merge commit itself. Effectively creating a new commit that reverses all
<li>Only very minor changes should be performed on a short-term release the relevant changes.</li>
branch directly. Any larger changes SHOULD be done in the master branch, </ol>
and SHOULD be pulled into the release branch by rebasing it on top of the </li>
master branch the same way a change branch pulls in updates from its <li>Git Best Practices
source branch.</li> <ol>
<li>After a release tag has been created, the release branch MUST be merged <li>All commit messages SHOULD follow the Commit Guidelines and format from
back into its source branch and then deleted. Typically the source branch the official git
will be the master branch.</li> documentation:
</ol> <a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
</li> <li>You SHOULD never blindly commit all changes with “git commit -a”. It is
<li>Long-term Release Branches RECOMMENDED you use “git add -i” or “git add -p” to add individual
<ol> changes to the staging area so you are fully aware of what you are
<li>Any release branch which has a name ending with a non-specific version committing.</li>
string, MUST be referred to as a "long-term release branch". For example <li>You SHOULD always use “—force-with-lease” when doing a force push. The
"release-2.11" is a long-term release branch, while "release-2.11.4" is a regular “—force” option is dangerous and destructive. More
short-term release branch.</li> information:
<li>Use of long-term release branches are OPTIONAL, and intended for work on <a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
versions which are not currently part of the master branch. Typically <li>You SHOULD understand and be comfortable with
this is useful when you need to create a new maintenance release for a rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
older version.</li> <li>It is RECOMMENDED that you always do “git pull —rebase” instead of “git
<li>A long-term release branch MUST have a name with a non-specific version pull” to avoid unnecessary merge commits. You can make this the default
number. For example a long-term release branch for creating new 2.9.x behavior of “git pull” with “git config —global pull.rebase true”.</li>
releases MUST be named "release-2.9".</li> <li>It is RECOMMENDED that all branches be merged using “git merge —no-ff”.
<li>Long-term release branches for maintenance releases of older versions This makes sure the reference to the original branch is kept in the
MUST be created from the relevant release tag. For example if the master commits, allows one to revert a merge by reverting a single merge commit,
branch is on version 2.11.4 and there is a security fix for all 2.9.x and creates a merge commit to mark the integration of the branch with
releases, the latest of which is "2.9.7". Create a new branch called master.</li>
"release-2.9" from the "2.9.7" release tag. The security fix release will </ol>
then end up being version "2.9.8".</li> </li>
<li>To create a new release from a long-term release branch, you MUST follow </ol>
the same process as a release from the master branch, except the <h2 id="faq">FAQ</h2>
long-term release branch takes the place of the master branch.</li> <h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<li>A long-term release branch should be treated with the same respect as the <p>Common-Flow tries to be a lot less complicated than Git Flow by having fewer
master branch. It is effectively the master branch for the release series types of branches, and simpler rules. Normal day to day development doesn’t
in question. Meaning it MUST always be in a non-broken state, MUST NOT be really change much:</p>
force pushed to, etc.</li> <ul>
</ol> <li>You create change branches instead of feature branches, without the need of a
</li> “feature/” or “change/” prefix in the branch name.</li>
<li>Bug Fixes &amp; Rollback <li>Change branches are typically created from and merged back into “master”
<ol> instead of “develop”.</li>
<li>You MUST NOT under any circumstances force push to the master branch or <li>Creating a release is done by simply creating a git tag, typically on the
to long-term release branches.</li> master branch.</li>
<li>If a change branch which has been merged into the master branch is found </ul>
to have a bug in it, the bug fix work MUST be done as a new separate <p>In detail, the main differences between Git Flow and Common-Flow are:</p>
change branch and MUST follow the same workflow as any other change <ul>
branch.</li> <li>There is no “develop” branch, there is only a “master” branch which contains
<li>If a change branch is wrongfully merged into master, or for any other the latest work. In Git Flow the master branch effectively ends up just being
reason the merge must be undone, you MUST undo the merge by reverting the a pointer to the latest release, despite the fact that Git Flow includes
merge commit itself. Effectively creating a new commit that reverses all release tags too. In Common-Flow you just look at the tags to find the latest
the relevant changes.</li> release.</li>
</ol> <li>There are no “feature” or “hotfix” branches, there’s only “change”
</li> branches. Any branch that is not master and introduces changes is a change
<li>Git Best Practices branch. Change branches also don’t have a enforced naming convention, they
<ol> just have to have a “descriptive name”. This makes things simpler and allows
<li>All commit messages SHOULD follow the Commit Guidelines and format from more flexibility.</li>
the official git <li>Release branches are available, but optional. Instead of enforcing the use of
documentation: release branches like Git Flow, Common-Flow only recommends the use of release
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li> branches when it makes things easier. If creating a new release by tagging
<li>You SHOULD never blindly commit all changes with "git commit -a". It is “master” works for you, great, do that.</li>
RECOMMENDED you use "git add -i" or "git add -p" to add individual </ul>
changes to the staging area so you are fully aware of what you are <h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
committing.</li> <p>Common-Flow is essentially GitHub Flow with the addition of a “Release” concept
<li>You SHOULD always use "--force-with-lease" when doing a force push. The that uses tags. It also attempts to define how certain common tasks are done,
regular "--force" option is dangerous and destructive. More like updating change/feature branches from their source branches for
information: example. This is to help end arguments about how such things are done.</p>
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li> <p>If a deployment/release for you is just getting the latest code in the master
<li>You SHOULD understand and be comfortable with branch out, without caring about bumping version numbers or anything, then
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li> GitHub Flow is a good fit for you, and you probably don’t need the extras of
<li>It is RECOMMENDED that you always do "git pull --rebase" instead of "git Common-Flow.</p>
pull" to avoid unnecessary merge commits. You can make this the default <p>However if your deployments/releases have specific version numbers, then
behavior of "git pull" with "git config --global pull.rebase true".</li> Common-Flow gives you a simple set of rules of how to create and manage
<li>It is RECOMMENDED that all branches be merged using "git merge --no-ff". releases, on top of what GitHub Flow already does.</p>
This makes sure the reference to the original branch is kept in the <h3 id="what-does-descriptive-name-mean-for-change-branches">What does “descriptive name” mean for change branches?</h3>
commits, allows one to revert a merge by reverting a single merge commit, <p>It means what it sounds like. The name should be descriptive, as in by just
and creates a merge commit to mark the integration of the branch with reading the name of the branch you should understand what the branch’s purpose
master.</li> is and what it does. Here’s a few examples:</p>
</ol> <ul>
</li> <li>add-2fa-support</li>
</ol> <li>fix-login-issue</li>
<h2 id="faq">FAQ</h2> <li>remove-sort-by-middle-name-functionality</li>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3> <li>update-font-awesome</li>
<p>Common-Flow tries to be a lot less complicated than Git Flow by having fewer <li>change-search-behavior</li>
types of branches, and simpler rules. Normal day to day development doesn't <li>improve-pagination-performance</li>
really change much:</p> <li>tweak-footer-style</li>
<ul> </ul>
<li>You create change branches instead of feature branches, without the need of a <p>Notice how none of these have any prefixes like “feature/” or “hotfix/”, they’re
"feature/" or "change/" prefix in the branch name.</li> not needed when branch names are properly descriptive. However there’s nothing
<li>Change branches are typically created from and merged back into "master" to say you can’t use such prefixes if you want.</p>
instead of "develop".</li> <p>You can also add ticket numbers to the branch name if your team/org has that as
<li>Creating a release is done by simply creating a git tag, typically on the part of it’s process. But it is recommended that ticket numbers are added to the
master branch.</li> end of the branch name. The ticket number is essentially metadata, so put it at
</ul> the end and out of the way of humans trying to read the descriptive name from
<p>In detail, the main differences between Git Flow and Common-Flow are:</p> left to right.</p>
<ul> <h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<li>There is no "develop" branch, there is only a "master" branch which contains <p>This should ideally never happen, however if it does you can do one of the
the latest work. In Git Flow the master branch effectively ends up just being following:</p>
a pointer to the latest release, despite the fact that Git Flow includes <ul>
release tags too. In Common-Flow you just look at the tags to find the latest <li>Review why the master branch is broken and revert the changes that caused the
release.</li> issues. Then apply the hotfix and release.</li>
<li>There are no "feature" or "hotfix" branches, there's only "change" <li>Or use a short-term release branch created from the latest release tag instead
branches. Any branch that is not master and introduces changes is a change of the master branch. Apply the hotfix to the release branch, create a release
branch. Change branches also don't have a enforced naming convention, they tag on the release branch, and then merge it back into master.</li>
just have to have a "descriptive name". This makes things simpler and allows </ul>
more flexibility.</li> <p>In this situation, it is recommended you try to revert the offending changes
<li>Release branches are available, but optional. Instead of enforcing the use of that’s preventing a new release from master. But if that proves to be a
release branches like Git Flow, Common-Flow only recommends the use of release complicated task and you’re short on time, a short-term release branch gives you
branches when it makes things easier. If creating a new release by tagging a instant fix to the situation at hand, and let’s you resolve the issues with
"master" works for you, great, do that.</li> the master branch when you have more time on your hands.</p>
</ul> <h2 id="about">About</h2>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3> <p>The Git Common-Flow specification is authored
<p>Common-Flow is essentially GitHub Flow with the addition of a "Release" concept by <a href="https://jimeh.me/">Jim Myhrberg</a>.</p>
that uses tags. It also attempts to define how certain common tasks are done, <p>If you’d like to leave feedback,
like updating change/feature branches from their source branches for please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
example. This is to help end arguments about how such things are done.</p> <h2 id="license">License</h2>
<p>If a deployment/release for you is just getting the latest code in the master <p><a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons - CC BY 4.0</a></p> </article> </div> </div> </div> </body></html>
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does "descriptive name" mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>improve-pagination-performance</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want.</p>
<p>You can also add ticket numbers to the branch name if your team/org has that as
part of it's process. But it is recommended that ticket numbers are added to the
end of the branch name. The ticket number is essentially metadata, so put it at
the end and out of the way of humans trying to read the descriptive name from
left to right.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
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.</p>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="https://jimeh.me/">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons - CC BY 4.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

1
docs/robots.txt
View File

@@ -1 +0,0 @@
Sitemap: https://commonflow.org/sitemap.xml

1
docs/sitemap-0.xml Normal file
View File

@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"><url><loc>https://commonflow.org/</loc></url><url><loc>https://commonflow.org/spec/1.0.0-rc.1/</loc></url><url><loc>https://commonflow.org/spec/1.0.0-rc.2/</loc></url><url><loc>https://commonflow.org/spec/1.0.0-rc.3/</loc></url><url><loc>https://commonflow.org/spec/1.0.0-rc.4/</loc></url><url><loc>https://commonflow.org/spec/1.0.0-rc.5/</loc></url></urlset>

1
docs/sitemap-index.xml Normal file
View File

@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>https://commonflow.org/sitemap-0.xml</loc></sitemap></sitemapindex>

21
docs/sitemap.xml
View File

@@ -1,21 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://commonflow.org/spec/1.0.0-rc.1.html</loc>
</url>
<url>
<loc>https://commonflow.org/spec/1.0.0-rc.2.html</loc>
</url>
<url>
<loc>https://commonflow.org/spec/1.0.0-rc.3.html</loc>
</url>
<url>
<loc>https://commonflow.org/spec/1.0.0-rc.4.html</loc>
</url>
<url>
<loc>https://commonflow.org/spec/1.0.0-rc.5.html</loc>
</url>
<url>
<loc>https://commonflow.org/</loc>
</url>
</urlset>

251
docs/spec/1.0.0-rc.1.html
View File

@@ -1,251 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css">
<!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.1 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.1" />
<meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.1.html" />
<meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.1.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"Git Common-Flow 1.0.0-rc.1","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/spec/1.0.0-rc.1.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.5">
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1 pure-menu-selected">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<h1 id="git-common-flow-100-rc1">Git Common-Flow 1.0.0-rc.1</h1>
<p><img src="/spec/1.0.0-rc.1.svg" width="100%" /></p>
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding
edge, and must be named <code class="highlighter-rouge">master</code>.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Maintenance Branches</strong> - Used for maintaining old versions and releasing
PATCH updates when the master branch has moved on. Should follow a
<code class="highlighter-rouge">stable-X.Y</code> naming pattern, where <code class="highlighter-rouge">X</code> is MAJOR version and <code class="highlighter-rouge">Y</code> is MINOR
version.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - Consists of a version bump commit directly on the master branch,
and a git tag named according to the new version string placed on said commit.</li>
<li><strong>Maintenance Release</strong> - Just like a regular release, except the version bump
commit and release tag are on a maintenance branch instead of the master
branch.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>The Master Branch
<ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<li>The master branch MUST be considered bleeding edge.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
</ol>
</li>
<li>Changes
<ol>
<li>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
is RECOMMENDED that you commit often locally, and you SHOULD regularly
push your work to the same named branch on the remote server.</li>
<li>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.</li>
<li>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. To be clear you MUST NOT merge a source branch into a
change branch.</li>
<li>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.</li>
<li>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
changes.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, it is RECOMMENDED you do this by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project</a></li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The
plain "--force" option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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"
located in the root of the project.</li>
<li>If you are using a "VERSION" file in the root of the project, this MUST
only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning
(<a href="http://semver.org/">http://semver.org/</a>) 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.</li>
</ol>
</li>
<li>Releases
<ol>
<li>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.</li>
<li>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"</li>
<li>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".</li>
<li>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.</li>
<li>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
be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Bug Fixes &amp; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>If a change branch which has been merged in to 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.</li>
<li>If a change branch is wrongfully merged in to 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.</li>
</ol>
</li>
<li>Maintenance Releases
<ol>
<li>Any branch that has a name starting with "stable-" SHOULD be referred to
as a "maintenance branch".</li>
<li>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.</li>
<li>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.</li>
<li>A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where
"X" is the MAJOR version and "Y" is the minor version.</li>
<li>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".</li>
<li>When working on a maintenance release, the relevant maintenance branch
MUST be thought of as the master branch for that maintenance work.</li>
<li>Changes in a maintenance branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up
into the master branch, that work should have happened against the master
branch in the first place.</li>
</ol>
</li>
</ol>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

196
docs/spec/1.0.0-rc.1/index.html Normal file
View File

@@ -0,0 +1,196 @@
<!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.1/"><title>Git Common-Flow 1.0.0-rc.1 | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Git Common-Flow 1.0.0-rc.1 | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.1/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Git Common-Flow 1.0.0-rc.1 | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css"></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item selected" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
9.504.5.092.682-.217.682-.483
0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
2.688 0 3.848-2.339 4.695-4.566
4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <article class="spec-content"> <h1 id="git-common-flow-100-rc1">Git Common-Flow 1.0.0-rc.1</h1>
<img src="/spec/1.0.0-rc.1.svg" alt="Git Common-Flow 1.0.0-rc.1 diagram" width="100%">
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding
edge, and must be named <code>master</code>.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Maintenance Branches</strong> - Used for maintaining old versions and releasing
PATCH updates when the master branch has moved on. Should follow a
<code>stable-X.Y</code> naming pattern, where <code>X</code> is MAJOR version and <code>Y</code> is MINOR
version.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - Consists of a version bump commit directly on the master branch,
and a git tag named according to the new version string placed on said commit.</li>
<li><strong>Maintenance Release</strong> - Just like a regular release, except the version bump
commit and release tag are on a maintenance branch instead of the master
branch.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>The Master Branch
<ol>
<li>A branch named “master” MUST exist and it MUST be referred to as the
“master branch”.</li>
<li>The master branch MUST be considered bleeding edge.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
</ol>
</li>
<li>Changes
<ol>
<li>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
is RECOMMENDED that you commit often locally, and you SHOULD regularly
push your work to the same named branch on the remote server.</li>
<li>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.</li>
<li>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. To be clear you MUST NOT merge a source branch into a
change branch.</li>
<li>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.</li>
<li>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
changes.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, it is RECOMMENDED you do this by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project</a></li>
<li>You SHOULD always use “—force-with-lease” when doing a force push. The
plain “—force” option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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”
located in the root of the project.</li>
<li>If you are using a “VERSION” file in the root of the project, this MUST
only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning
(<a href="http://semver.org/">http://semver.org/</a>) 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.</li>
</ol>
</li>
<li>Releases
<ol>
<li>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.</li>
<li>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”</li>
<li>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”.</li>
<li>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.</li>
<li>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
be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Bug Fixes &#x26; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>If a change branch which has been merged in to 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.</li>
<li>If a change branch is wrongfully merged in to 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.</li>
</ol>
</li>
<li>Maintenance Releases
<ol>
<li>Any branch that has a name starting with “stable-” SHOULD be referred to
as a “maintenance branch”.</li>
<li>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.</li>
<li>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.</li>
<li>A maintenance branch SHOULD follow a “stable-X.Y” naming pattern, where
“X” is the MAJOR version and “Y” is the minor version.</li>
<li>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”.</li>
<li>When working on a maintenance release, the relevant maintenance branch
MUST be thought of as the master branch for that maintenance work.</li>
<li>Changes in a maintenance branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up
into the master branch, that work should have happened against the master
branch in the first place.</li>
</ol>
</li>
</ol>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you’d like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p> </article> </div> </div> </div> </body></html>

285
docs/spec/1.0.0-rc.2.html
View File

@@ -1,285 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css">
<!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.2 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.2" />
<meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.2.html" />
<meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.2.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"Git Common-Flow 1.0.0-rc.2","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/spec/1.0.0-rc.2.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.5">
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2 pure-menu-selected">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<h1 id="git-common-flow-100-rc2">Git Common-Flow 1.0.0-rc.2</h1>
<p><img src="/spec/1.0.0-rc.2.svg" width="100%" /></p>
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding
edge, and must be named <code class="highlighter-rouge">master</code>.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - Consists of a version bump commit, and a git tag named according
to the new version string placed on said commit.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>The Master Branch
<ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<li>The master branch MUST be considered bleeding edge.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
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.</li>
<li>You MUST create separate change branches for each distinctly different
change. You MUST NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>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.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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"
located in the root of the project.</li>
<li>If you are using a "VERSION" file in the root of the project, this MUST
only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning
(<a href="http://semver.org/">http://semver.org/</a>) 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.</li>
</ol>
</li>
<li>Releases
<ol>
<li>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.</li>
<li>If you are not using a release branch, then the version bump commit MUST
be created directly on the master branch.</li>
<li>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"</li>
<li>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
and stick to it.</li>
<li>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.</li>
<li>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
be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Release Branches
<ol>
<li>Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".</li>
<li>Use of release branches is OPTIONAL.</li>
<li>Changes in a release branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up
into the master branch, that work should have happened against the master
branch in the first place. One exception to this is version bump commits.</li>
<li>There are two types of release branches; short-term, and long-term.</li>
<li>Short-Term Release Branches
<ol>
<li>Used for creating a specific versioned release.</li>
<li>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.</li>
<li>MUST have a name of "release-VERSION". For example for version
"2.11.4" the release branch name MUST be "release-2.11.4".</li>
<li>When using a short-term release branch, the version bump commit and
release tag MUST be made directly on the release branch itself.</li>
<li>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.</li>
<li>After the version bump commit and release tag have 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.</li>
</ol>
</li>
<li>Long-Term Release Branches
<ol>
<li>Used 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.</li>
<li>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".</li>
<li>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.</li>
<li>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"
release tag. The security fix release will then end up being version
"2.9.8".</li>
</ol>
</li>
</ol>
</li>
<li>Bug Fixes &amp; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project</a></li>
<li>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.</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

230
docs/spec/1.0.0-rc.2/index.html Normal file
View File

@@ -0,0 +1,230 @@
<!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.2/"><title>Git Common-Flow 1.0.0-rc.2 | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Git Common-Flow 1.0.0-rc.2 | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.2/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Git Common-Flow 1.0.0-rc.2 | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css"></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item selected" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
9.504.5.092.682-.217.682-.483
0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
2.688 0 3.848-2.339 4.695-4.566
4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <article class="spec-content"> <h1 id="git-common-flow-100-rc2">Git Common-Flow 1.0.0-rc.2</h1>
<img src="/spec/1.0.0-rc.2.svg" alt="Git Common-Flow 1.0.0-rc.2 diagram" width="100%">
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding
edge, and must be named <code>master</code>.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - Consists of a version bump commit, and a git tag named according
to the new version string placed on said commit.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>The Master Branch
<ol>
<li>A branch named “master” MUST exist and it MUST be referred to as the
“master branch”.</li>
<li>The master branch MUST be considered bleeding edge.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
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.</li>
<li>You MUST create separate change branches for each distinctly different
change. You MUST NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>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.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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”
located in the root of the project.</li>
<li>If you are using a “VERSION” file in the root of the project, this MUST
only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning
(<a href="http://semver.org/">http://semver.org/</a>) 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.</li>
</ol>
</li>
<li>Releases
<ol>
<li>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.</li>
<li>If you are not using a release branch, then the version bump commit MUST
be created directly on the master branch.</li>
<li>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”</li>
<li>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
and stick to it.</li>
<li>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.</li>
<li>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
be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Release Branches
<ol>
<li>Any branch that has a name starting with “release-” SHOULD be referred to
as a “release branch”.</li>
<li>Use of release branches is OPTIONAL.</li>
<li>Changes in a release branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up
into the master branch, that work should have happened against the master
branch in the first place. One exception to this is version bump commits.</li>
<li>There are two types of release branches; short-term, and long-term.</li>
<li>Short-Term Release Branches
<ol>
<li>Used for creating a specific versioned release.</li>
<li>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.</li>
<li>MUST have a name of “release-VERSION”. For example for version
“2.11.4” the release branch name MUST be “release-2.11.4”.</li>
<li>When using a short-term release branch, the version bump commit and
release tag MUST be made directly on the release branch itself.</li>
<li>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.</li>
<li>After the version bump commit and release tag have 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.</li>
</ol>
</li>
<li>Long-Term Release Branches
<ol>
<li>Used 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.</li>
<li>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”.</li>
<li>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.</li>
<li>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”
release tag. The security fix release will then end up being version
“2.9.8”.</li>
</ol>
</li>
</ol>
</li>
<li>Bug Fixes &#x26; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project</a></li>
<li>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.</li>
<li>You SHOULD always use “—force-with-lease” when doing a force push. The
regular “—force” option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you’d like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p> </article> </div> </div> </div> </body></html>

294
docs/spec/1.0.0-rc.3.html
View File

@@ -1,294 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css">
<!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.3 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.3" />
<meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.3.html" />
<meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.3.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"Git Common-Flow 1.0.0-rc.3","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/spec/1.0.0-rc.3.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.5">
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3 pure-menu-selected">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<h1 id="git-common-flow-100-rc3">Git Common-Flow 1.0.0-rc.3</h1>
<p><img src="/spec/1.0.0-rc.3.svg" width="100%" /></p>
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named "master", must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production
environments. Consists of a version bump commit, and a git tag named according
to the new version string placed on said commit.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Don't break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
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.</li>
<li>You MUST create separate change branches for each distinctly different
change. You MUST NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>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.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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"
located in the root of the project.</li>
<li>If you are using a "VERSION" file in the root of the project, this MUST
only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning
(<a href="http://semver.org/">http://semver.org/</a>) 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.</li>
</ol>
</li>
<li>Releases
<ol>
<li>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.</li>
<li>If you are not using a release branch, then the version bump commit MUST
be created directly on the master branch.</li>
<li>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"</li>
<li>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
and stick to it.</li>
<li>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.</li>
<li>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
be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Release Branches
<ol>
<li>Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".</li>
<li>Use of release branches is OPTIONAL.</li>
<li>Changes in a release branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up
into the master branch, that work should have happened against the master
branch in the first place. One exception to this is version bump commits.</li>
<li>There are two types of release branches; short-term, and long-term.</li>
<li>Short-Term Release Branches
<ol>
<li>Used for creating a specific versioned release.</li>
<li>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.</li>
<li>MUST have a name of "release-VERSION". For example for version
"2.11.4" the release branch name MUST be "release-2.11.4".</li>
<li>When using a short-term release branch, the version bump commit and
release tag MUST be made directly on the release branch itself.</li>
<li>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.</li>
<li>After the version bump commit and release tag have 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.</li>
</ol>
</li>
<li>Long-Term Release Branches
<ol>
<li>Used 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.</li>
<li>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".</li>
<li>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.</li>
<li>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"
release tag. The security fix release will then end up being version
"2.9.8".</li>
</ol>
</li>
</ol>
</li>
<li>Bug Fixes &amp; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>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.</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

239
docs/spec/1.0.0-rc.3/index.html Normal file
View File

@@ -0,0 +1,239 @@
<!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.3/"><title>Git Common-Flow 1.0.0-rc.3 | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Git Common-Flow 1.0.0-rc.3 | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.3/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Git Common-Flow 1.0.0-rc.3 | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css"></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item selected" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
9.504.5.092.682-.217.682-.483
0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
2.688 0 3.848-2.339 4.695-4.566
4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <article class="spec-content"> <h1 id="git-common-flow-100-rc3">Git Common-Flow 1.0.0-rc.3</h1>
<img src="/spec/1.0.0-rc.3.svg" alt="Git Common-Flow 1.0.0-rc.3 diagram" width="100%">
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named “master”, must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production
environments. Consists of a version bump commit, and a git tag named according
to the new version string placed on said commit.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Don’t break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named “master” MUST exist and it MUST be referred to as the
“master branch”.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
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.</li>
<li>You MUST create separate change branches for each distinctly different
change. You MUST NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>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.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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”
located in the root of the project.</li>
<li>If you are using a “VERSION” file in the root of the project, this MUST
only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning
(<a href="http://semver.org/">http://semver.org/</a>) 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.</li>
</ol>
</li>
<li>Releases
<ol>
<li>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.</li>
<li>If you are not using a release branch, then the version bump commit MUST
be created directly on the master branch.</li>
<li>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”</li>
<li>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
and stick to it.</li>
<li>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.</li>
<li>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
be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Release Branches
<ol>
<li>Any branch that has a name starting with “release-” SHOULD be referred to
as a “release branch”.</li>
<li>Use of release branches is OPTIONAL.</li>
<li>Changes in a release branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up
into the master branch, that work should have happened against the master
branch in the first place. One exception to this is version bump commits.</li>
<li>There are two types of release branches; short-term, and long-term.</li>
<li>Short-Term Release Branches
<ol>
<li>Used for creating a specific versioned release.</li>
<li>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.</li>
<li>MUST have a name of “release-VERSION”. For example for version
“2.11.4” the release branch name MUST be “release-2.11.4”.</li>
<li>When using a short-term release branch, the version bump commit and
release tag MUST be made directly on the release branch itself.</li>
<li>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.</li>
<li>After the version bump commit and release tag have 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.</li>
</ol>
</li>
<li>Long-Term Release Branches
<ol>
<li>Used 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.</li>
<li>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”.</li>
<li>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.</li>
<li>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”
release tag. The security fix release will then end up being version
“2.9.8”.</li>
</ol>
</li>
</ol>
</li>
<li>Bug Fixes &#x26; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>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.</li>
<li>You SHOULD always use “—force-with-lease” when doing a force push. The
regular “—force” option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you’d like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p> </article> </div> </div> </div> </body></html>

406
docs/spec/1.0.0-rc.4.html
View File

@@ -1,406 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css">
<!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.4 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.4" />
<meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.4.html" />
<meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.4.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"Git Common-Flow 1.0.0-rc.4","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/spec/1.0.0-rc.4.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.5">
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.4 pure-menu-selected">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<h1 id="git-common-flow-100-rc4">Git Common-Flow 1.0.0-rc.4</h1>
<p><img src="/spec/1.0.0-rc.4.svg" width="100%" /></p>
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named "master", must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production environments. Is
effectively just a git tag named after the version of the release.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Don't break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as "change branches".</li>
<li>All change branches MUST have descriptive names.</li>
<li>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.</li>
<li>You SHOULD regularly push your work to the same named branch on the
remote server.</li>
<li>You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent).</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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.</li>
<li>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".</li>
<li>It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.</li>
<li>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.</li>
<li>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.</li>
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
</ol>
</li>
<li>Releases
<ol>
<li>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".</li>
<li>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.</li>
<li>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.</li>
<li>When using version bump commits, the release tag MUST be placed on the
version bump commit.</li>
<li>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.</li>
<li>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"</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Short-Term Release Branches
<ol>
<li>Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".</li>
<li>Any release branch which has a name ending with a specific version
string, MUST be referred to as a "short-term release branch".</li>
<li>Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.</li>
<li>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.</li>
<li>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".</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Long-term Release Branches
<ol>
<li>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.</li>
<li>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.</li>
<li>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".</li>
<li>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".</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Bug Fixes &amp; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>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.</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="faq">FAQ</h2>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<p>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
really change much:</p>
<ul>
<li>You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.</li>
<li>Change branches are typically created off of and merged back into "master"
instead of "develop".</li>
<li>Creating a release is done by simply creating a git tag, typically on the
master branch.</li>
</ul>
<p>In detail, the main differences between Git Flow and Common-Flow are:</p>
<ul>
<li>There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.</li>
<li>There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.</li>
<li>Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.</li>
</ul>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
<p>Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.</p>
<p>If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does "descriptive name" mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it's process.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
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.</p>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

351
docs/spec/1.0.0-rc.4/index.html Normal file
View File

@@ -0,0 +1,351 @@
<!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.4/"><title>Git Common-Flow 1.0.0-rc.4 | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Git Common-Flow 1.0.0-rc.4 | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.4/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Git Common-Flow 1.0.0-rc.4 | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css"></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item selected" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
9.504.5.092.682-.217.682-.483
0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
2.688 0 3.848-2.339 4.695-4.566
4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <article class="spec-content"> <h1 id="git-common-flow-100-rc4">Git Common-Flow 1.0.0-rc.4</h1>
<img src="/spec/1.0.0-rc.4.svg" alt="Git Common-Flow 1.0.0-rc.4 diagram" width="100%">
<h2 id="summary">Summary</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>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.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named “master”, must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production environments. Is
effectively just a git tag named after the version of the release.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Don’t break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named “master” MUST exist and it MUST be referred to as the
“master branch”.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as “change branches”.</li>
<li>All change branches MUST have descriptive names.</li>
<li>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.</li>
<li>You SHOULD regularly push your work to the same named branch on the
remote server.</li>
<li>You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>To merge a change branch into its merge target, you MUST open a “pull
request” (or equivalent).</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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.</li>
<li>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”.</li>
<li>It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.</li>
<li>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.</li>
<li>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.</li>
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
</ol>
</li>
<li>Releases
<ol>
<li>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”.</li>
<li>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.</li>
<li>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.</li>
<li>When using version bump commits, the release tag MUST be placed on the
version bump commit.</li>
<li>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.</li>
<li>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”</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Short-Term Release Branches
<ol>
<li>Any branch that has a name starting with “release-” SHOULD be referred to
as a “release branch”.</li>
<li>Any release branch which has a name ending with a specific version
string, MUST be referred to as a “short-term release branch”.</li>
<li>Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.</li>
<li>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.</li>
<li>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”.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Long-term Release Branches
<ol>
<li>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.</li>
<li>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.</li>
<li>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”.</li>
<li>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”.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Bug Fixes &#x26; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>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.</li>
<li>You SHOULD always use “—force-with-lease” when doing a force push. The
regular “—force” option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="faq">FAQ</h2>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<p>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
really change much:</p>
<ul>
<li>You create change branches instead of feature branches, without the need of a
“feature/” or “change/” prefix in the branch name.</li>
<li>Change branches are typically created off of and merged back into “master”
instead of “develop”.</li>
<li>Creating a release is done by simply creating a git tag, typically on the
master branch.</li>
</ul>
<p>In detail, the main differences between Git Flow and Common-Flow are:</p>
<ul>
<li>There is no “develop” branch, there is only a “master” branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.</li>
<li>There are no “feature” or “hotfix” branches, there’s only “change”
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don’t have a enforced naming convention, they
just have to have a “descriptive name”. This makes things simpler and allows
more flexibility.</li>
<li>Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
“master” works for you, great, do that.</li>
</ul>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
<p>Common-Flow is essentially GitHub Flow with the addition of a “Release” concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.</p>
<p>If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don’t need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does “descriptive name” mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch’s purpose
is and what it does. Here’s a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like “feature/” or “hotfix/”, they’re
not needed when branch names are properly descriptive. However there’s nothing
to say you can’t use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it’s process.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
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.</p>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you’d like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p> </article> </div> </div> </div> </body></html>

425
docs/spec/1.0.0-rc.5.html
View File

@@ -1,425 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-c6d2e6591d58bffada09ccc7f6d4f28960908c6bdb6192e726de2a896036b150.css">
<!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.5 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.5" />
<meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.5.html" />
<meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.5.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"Git Common-Flow 1.0.0-rc.5","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/spec/1.0.0-rc.5.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.5 pure-menu-selected">
<a href="/spec/1.0.0-rc.5.html" class="pure-menu-link">1.0.0-rc.5</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<h1 id="git-common-flow-100-rc5">Git Common-Flow 1.0.0-rc.5</h1>
<p><img src="/spec/1.0.0-rc.5.svg" width="100%" /></p>
<h2 id="introduction">Introduction</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects most commonly use git.</p>
<p>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.</p>
<h2 id="summary">Summary</h2>
<ul>
<li>The "master" branch is the mainline branch with latest changes, and must not
be broken.</li>
<li>Changes (features, bugfixes, etc.) are done on "change branches" created from
the master branch.</li>
<li>Rebase change branches <a href="https://i.imgur.com/1RS8x2d.png">early and often</a>.</li>
<li>When a change branch is stable and ready, it is merged back in to master.</li>
<li>A release is just a git tag who's name is the exact release version string
(e.g. "2.11.4").</li>
<li>Release branches can be used to avoid change freezes on master. They are not
required, instead they are available if you need them.</li>
</ul>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named "master", must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production environments. Is
effectively just a git tag named after the version of the release.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Do not break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as "change branches".</li>
<li>All change branches MUST have descriptive names.</li>
<li>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.</li>
<li>You SHOULD regularly push your work to the same named branch on the
remote server.</li>
<li>You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent).</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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.</li>
<li>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".</li>
<li>It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.</li>
<li>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.</li>
<li>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.</li>
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
</ol>
</li>
<li>Releases
<ol>
<li>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".</li>
<li>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.</li>
<li>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.</li>
<li>When using version bump commits, the release tag MUST be placed on the
version bump commit.</li>
<li>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.</li>
<li>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"</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Short-Term Release Branches
<ol>
<li>Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".</li>
<li>Any release branch which has a name ending with a specific version
string, MUST be referred to as a "short-term release branch".</li>
<li>Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.</li>
<li>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.</li>
<li>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".</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Long-term Release Branches
<ol>
<li>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.</li>
<li>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.</li>
<li>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".</li>
<li>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".</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Bug Fixes &amp; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>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.</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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".</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="faq">FAQ</h2>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<p>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
really change much:</p>
<ul>
<li>You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.</li>
<li>Change branches are typically created from and merged back into "master"
instead of "develop".</li>
<li>Creating a release is done by simply creating a git tag, typically on the
master branch.</li>
</ul>
<p>In detail, the main differences between Git Flow and Common-Flow are:</p>
<ul>
<li>There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.</li>
<li>There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.</li>
<li>Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.</li>
</ul>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
<p>Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.</p>
<p>If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does "descriptive name" mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>improve-pagination-performance</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want.</p>
<p>You can also add ticket numbers to the branch name if your team/org has that as
part of it's process. But it is recommended that ticket numbers are added to the
end of the branch name. The ticket number is essentially metadata, so put it at
the end and out of the way of humans trying to read the descriptive name from
left to right.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
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.</p>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="https://jimeh.me/">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons - CC BY 4.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

370
docs/spec/1.0.0-rc.5/index.html Normal file
View File

@@ -0,0 +1,370 @@
<!DOCTYPE html><html lang="en" data-astro-cid-jwirc66j> <head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.5/"><title>Git Common-Flow 1.0.0-rc.5 | Git Common Flow</title><meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta name="author" content="Jim Myhrberg"><!-- Open Graph --><meta property="og:title" content="Git Common-Flow 1.0.0-rc.5 | Git Common Flow"><meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><meta property="og:type" content="website"><meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.5/"><!-- Twitter --><meta name="twitter:card" content="summary"><meta name="twitter:title" content="Git Common-Flow 1.0.0-rc.5 | Git Common Flow"><meta name="twitter:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification."><!-- Fonts --><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet"><link rel="stylesheet" href="/_astro/index.BMC0NJ9O.css"></head> <body data-astro-cid-jwirc66j> <div id="layout" data-astro-cid-jwirc66j> <a href="#menu" id="menuLink" class="menu-link" data-astro-cid-jyixok4n> <span data-astro-cid-jyixok4n></span> </a> <script type="module">function c(){const e=document.getElementById("layout"),n=document.getElementById("menu"),t=document.getElementById("menuLink"),s=document.getElementById("main");function i(o){o.preventDefault(),e?.classList.toggle("active"),n?.classList.toggle("active"),t?.classList.toggle("active")}function a(){e?.classList.remove("active"),n?.classList.remove("active"),t?.classList.remove("active")}t?.addEventListener("click",i),s?.addEventListener("click",()=>{e?.classList.contains("active")&&a()})}c();document.addEventListener("astro:after-swap",c);</script> <div id="menu" data-astro-cid-ssfzsv2f> <div class="menu-inner" data-astro-cid-ssfzsv2f> <ul class="menu-list" data-astro-cid-ssfzsv2f> <li class="menu-label" data-astro-cid-ssfzsv2f>Versions:</li> <li class="menu-item selected" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.5" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.5 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.4" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.4 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.3" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.3 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.2" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.2 </a> </li><li class="menu-item" data-astro-cid-ssfzsv2f> <a href="/spec/1.0.0-rc.1" class="menu-link-item" data-astro-cid-ssfzsv2f> 1.0.0-rc.1 </a> </li> </ul> </div> <div class="links" data-astro-cid-ssfzsv2f> <a href="https://github.com/jimeh/common-flow" aria-label="View on GitHub" class="github-link" data-astro-cid-ssfzsv2f> <svg class="w-12 h-12" fill="currentColor" viewBox="0 0 24 24" aria-hidden="true" data-astro-cid-ssfzsv2f> <path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
9.504.5.092.682-.217.682-.483
0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
2.688 0 3.848-2.339 4.695-4.566
4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
6.484 17.522 2 12 2z" clip-rule="evenodd" data-astro-cid-ssfzsv2f></path> </svg> </a> </div> </div> <div id="main" data-astro-cid-jwirc66j> <div class="content" data-astro-cid-jwirc66j> <article class="spec-content"> <h1 id="git-common-flow-100-rc5">Git Common-Flow 1.0.0-rc.5</h1>
<img src="/spec/1.0.0-rc.5.svg" alt="Git Common-Flow 1.0.0-rc.5 diagram" width="100%">
<h2 id="introduction">Introduction</h2>
<p>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 <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects most commonly use git.</p>
<p>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.</p>
<h2 id="summary">Summary</h2>
<ul>
<li>The “master” branch is the mainline branch with latest changes, and must not
be broken.</li>
<li>Changes (features, bugfixes, etc.) are done on “change branches” created from
the master branch.</li>
<li>Rebase change branches <a href="https://i.imgur.com/1RS8x2d.png">early and often</a>.</li>
<li>When a change branch is stable and ready, it is merged back in to master.</li>
<li>A release is just a git tag who’s name is the exact release version string
(e.g. “2.11.4”).</li>
<li>Release branches can be used to avoid change freezes on master. They are not
required, instead they are available if you need them.</li>
</ul>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named “master”, must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - 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.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production environments. Is
effectively just a git tag named after the version of the release.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>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 <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Do not break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named “master” MUST exist and it MUST be referred to as the
“master branch”.</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as “change branches”.</li>
<li>All change branches MUST have descriptive names.</li>
<li>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.</li>
<li>You SHOULD regularly push your work to the same named branch on the
remote server.</li>
<li>You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.</li>
<li>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.</li>
<li>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.</li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>To merge a change branch into its merge target, you MUST open a “pull
request” (or equivalent).</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>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.</li>
<li>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”.</li>
<li>It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.</li>
<li>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.</li>
<li>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.</li>
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
</ol>
</li>
<li>Releases
<ol>
<li>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”.</li>
<li>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.</li>
<li>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.</li>
<li>When using version bump commits, the release tag MUST be placed on the
version bump commit.</li>
<li>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.</li>
<li>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”</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Short-Term Release Branches
<ol>
<li>Any branch that has a name starting with “release-” SHOULD be referred to
as a “release branch”.</li>
<li>Any release branch which has a name ending with a specific version
string, MUST be referred to as a “short-term release branch”.</li>
<li>Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.</li>
<li>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.</li>
<li>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”.</li>
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Long-term Release Branches
<ol>
<li>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.</li>
<li>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.</li>
<li>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”.</li>
<li>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”.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Bug Fixes &#x26; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.</li>
<li>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.</li>
<li>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.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>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.</li>
<li>You SHOULD always use “—force-with-lease” when doing a force push. The
regular “—force” option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>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”.</li>
<li>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.</li>
</ol>
</li>
</ol>
<h2 id="faq">FAQ</h2>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<p>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
really change much:</p>
<ul>
<li>You create change branches instead of feature branches, without the need of a
“feature/” or “change/” prefix in the branch name.</li>
<li>Change branches are typically created from and merged back into “master”
instead of “develop”.</li>
<li>Creating a release is done by simply creating a git tag, typically on the
master branch.</li>
</ul>
<p>In detail, the main differences between Git Flow and Common-Flow are:</p>
<ul>
<li>There is no “develop” branch, there is only a “master” branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.</li>
<li>There are no “feature” or “hotfix” branches, there’s only “change”
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don’t have a enforced naming convention, they
just have to have a “descriptive name”. This makes things simpler and allows
more flexibility.</li>
<li>Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
“master” works for you, great, do that.</li>
</ul>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
<p>Common-Flow is essentially GitHub Flow with the addition of a “Release” concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.</p>
<p>If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don’t need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does “descriptive name” mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch’s purpose
is and what it does. Here’s a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>improve-pagination-performance</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like “feature/” or “hotfix/”, they’re
not needed when branch names are properly descriptive. However there’s nothing
to say you can’t use such prefixes if you want.</p>
<p>You can also add ticket numbers to the branch name if your team/org has that as
part of it’s process. But it is recommended that ticket numbers are added to the
end of the branch name. The ticket number is essentially metadata, so put it at
the end and out of the way of humans trying to read the descriptive name from
left to right.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
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.</p>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="https://jimeh.me/">Jim Myhrberg</a>.</p>
<p>If you’d like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons - CC BY 4.0</a></p> </article> </div> </div> </div> </body></html>

362
index.md
View File

@@ -1,362 +0,0 @@
---
title: Git Common-Flow 1.0.0-rc.5
version: 1.0.0-rc.5
---
Git Common-Flow 1.0.0-rc.5
===========================
<img src="/spec/1.0.0-rc.5.svg" width="100%" />
Introduction
------------
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](http://scottchacon.com/2011/08/31/github-flow.html)
of [GitHub Flow](https://guides.github.com/introduction/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
be broken.
- Changes (features, bugfixes, etc.) are done on "change branches" created from
the master branch.
- Rebase change branches [early and often](https://i.imgur.com/1RS8x2d.png).
- 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.
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 (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
interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
1. TL;DR
1. Do not break the master branch.
2. 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. 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. 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. 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
history.
4. You SHOULD regularly push your work to the same named branch on the
remote server.
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. 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. 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. 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. 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.
4. Pull Requests
1. To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent).
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. 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. 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. 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.
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. 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. It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.
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. 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. It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<http://semver.org/>).
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. 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. 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. When using version bump commits, the release tag MUST be placed on the
version bump commit.
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. 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. 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
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. Any release branch which has a name ending with a specific version
string, MUST be referred to as a "short-term release branch".
3. Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.
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. 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. 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. 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. 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.
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. 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. 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. 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. 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.
7. 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.
9. Bug Fixes & Rollback
1. You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.
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. 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.
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. 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. 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. You SHOULD understand and be comfortable with
rebasing: <https://git-scm.com/book/en/v2/Git-Branching-Rebasing>
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. 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.
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
really change much:
- You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.
- Change branches are typically created from and merged back into "master"
instead of "develop".
- Creating a release is done by simply creating a git tag, typically on the
master branch.
In detail, the main differences between Git Flow and Common-Flow are:
- There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.
- There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.
- Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.
### Why use Common-Flow instead of GitHub Flow, and how does it differ?
Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.
If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.
However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.
### What does "descriptive name" mean for change branches?
It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:
- add-2fa-support
- fix-login-issue
- remove-sort-by-middle-name-functionality
- update-font-awesome
- change-search-behavior
- improve-pagination-performance
- tweak-footer-style
Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want.
You can also add ticket numbers to the branch name if your team/org has that as
part of it's process. But it is recommended that ticket numbers are added to the
end of the branch name. The ticket number is essentially metadata, so put it at
the end and out of the way of humans trying to read the descriptive name from
left to right.
### How do we release an emergency hotfix when the master branch is broken?
This should ideally never happen, however if it does you can do one of the
following:
- Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.
- Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.
In this situation, it is recommended you try to revert the offending changes
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.
About
-----
The Git Common-Flow specification is authored
by [Jim Myhrberg](https://jimeh.me/).
If you'd like to leave feedback,
please [open an issue on GitHub](https://github.com/jimeh/common-flow/issues).
License
-------
[Creative Commons - CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)

6830
package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

23
package.json Normal file
View File

@@ -0,0 +1,23 @@
{
"name": "commonflow-org",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"build": "astro build",
"preview": "astro preview",
"update": "tsx scripts/update-specs.ts",
"astro": "astro"
},
"dependencies": {
"@astrojs/sitemap": "^3.2.1",
"astro": "^5.1.1"
},
"devDependencies": {
"@tailwindcss/typography": "^0.5.16",
"@tailwindcss/vite": "^4.0.0",
"tailwindcss": "^4.0.0",
"tsx": "^4.19.2",
"typescript": "^5.7.2"
}
}

0
public/.nojekyll Normal file
View File

0
spec/1.0.0-rc.1.svg → public/spec/1.0.0-rc.1.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

0
spec/1.0.0-rc.2.svg → public/spec/1.0.0-rc.2.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

0
spec/1.0.0-rc.3.svg → public/spec/1.0.0-rc.3.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

0
spec/1.0.0-rc.4.svg → public/spec/1.0.0-rc.4.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

0
spec/1.0.0-rc.5.svg → public/spec/1.0.0-rc.5.svg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

157
scripts/update-specs.ts Normal file
View File

@@ -0,0 +1,157 @@
/**
* Fetches spec documents and diagrams from the common-flow GitHub repo
* and writes them to the appropriate locations for Astro to consume.
*
* Equivalent to the Jekyll Rakefile's `rake update` task.
*/
import * as fs from "node:fs";
import * as path from "node:path";
const config = {
currentVersion: "1.0.0-rc.5",
versions: [
"1.0.0-rc.5",
"1.0.0-rc.4",
"1.0.0-rc.3",
"1.0.0-rc.2",
"1.0.0-rc.1",
],
update: {
urlTemplate:
"https://github.com/jimeh/common-flow/raw/{{version}}/{{file}}",
bodyTemplate: `---
title: {{title}}
version: {{version}}
---
{{content}}`,
imgTemplate:
'<img src="/spec/{{file}}" alt="{{title}} diagram" width="100%" />',
outputDir: "src/content/spec",
publicDir: "public/spec",
files: {
document: "common-flow.md",
diagram: "common-flow.svg",
},
},
};
function buildFileUrl(
fileType: "document" | "diagram",
version: string
): string {
const file = config.update.files[fileType];
return config.update.urlTemplate
.replace("{{version}}", version)
.replace("{{file}}", file);
}
async function fetchFile(url: string): Promise<string | null> {
try {
const response = await fetch(url);
if (!response.ok) {
return null;
}
return await response.text();
} catch {
return null;
}
}
function writeFile(filePath: string, content: string, comment = ""): void {
const dir = path.dirname(filePath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
}
fs.writeFileSync(filePath, content);
console.log(` - ${filePath}${comment}`);
}
function removeAllSpecs(): void {
console.log("\nRemoving existing spec files:");
for (const dir of [config.update.outputDir, config.update.publicDir]) {
if (fs.existsSync(dir)) {
const files = fs.readdirSync(dir);
for (const file of files) {
const filePath = path.join(dir, file);
fs.unlinkSync(filePath);
console.log(` ${filePath}`);
}
}
}
}
interface Spec {
version: string;
title: string;
body: string;
diagram: string | null;
}
async function fetchSpec(version: string): Promise<Spec> {
const documentUrl = buildFileUrl("document", version);
const diagramUrl = buildFileUrl("diagram", version);
let document = await fetchFile(documentUrl);
const diagram = await fetchFile(diagramUrl);
if (!document) {
throw new Error(`Failed to fetch document for version ${version}`);
}
// Replace {{version}} placeholder throughout the document
document = document.replaceAll("{{version}}", version);
// Extract title from first line (after version replacement)
const title = document.split("\n", 1)[0];
// If diagram exists, inject image tag after the title
if (diagram) {
const imgTag = config.update.imgTemplate
.replace("{{file}}", `${version}.svg`)
.replace("{{title}}", title);
document = document.replace(/^(.*\n=+\n)/, `$1\n${imgTag}\n`);
}
// Build body with frontmatter
const body = config.update.bodyTemplate
.replace("{{content}}", document)
.replace("{{title}}", title)
.replace("{{version}}", version);
return {
version,
title,
body,
diagram,
};
}
async function main(): Promise<void> {
removeAllSpecs();
console.log("\nFetching configured spec versions:");
for (const version of config.versions) {
try {
const spec = await fetchSpec(version);
// Write markdown file to content collection
const mdPath = path.join(config.update.outputDir, `${version}.md`);
writeFile(mdPath, spec.body);
// Write SVG diagram to public directory
if (spec.diagram) {
const svgPath = path.join(config.update.publicDir, `${version}.svg`);
writeFile(svgPath, spec.diagram);
}
} catch (error) {
console.error(`Error processing version ${version}:`, error);
}
}
console.log("\nDone! Run `npm run build` to rebuild the site.");
}
main();

100
src/components/MenuToggle.astro Normal file
View File

@@ -0,0 +1,100 @@
---
// Mobile hamburger menu toggle button
---
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<style>
.menu-link {
position: fixed;
display: block;
top: 0;
left: 0;
background: rgba(0, 0, 0, 0.7);
font-size: 10px;
z-index: 10;
width: 2em;
height: auto;
padding: 2.1em 1.6em;
transition: all 0.2s ease-out;
}
.menu-link:hover,
.menu-link:focus {
background: #000;
}
.menu-link span {
position: relative;
display: block;
}
.menu-link span,
.menu-link span:before,
.menu-link span:after {
background-color: #fff;
width: 100%;
height: 0.2em;
}
.menu-link span:before,
.menu-link span:after {
position: absolute;
margin-top: -0.6em;
content: " ";
}
.menu-link span:after {
margin-top: 0.6em;
}
/* Desktop: hide toggle and position at sidebar edge */
@media (min-width: 48em) {
.menu-link {
left: 150px;
display: none;
}
}
/* When menu is active, move toggle */
:global(#layout.active) .menu-link {
left: 150px;
}
</style>
<script>
function initMenuToggle() {
const layout = document.getElementById("layout");
const menu = document.getElementById("menu");
const menuLink = document.getElementById("menuLink");
const main = document.getElementById("main");
function toggleMenu(e: Event) {
e.preventDefault();
layout?.classList.toggle("active");
menu?.classList.toggle("active");
menuLink?.classList.toggle("active");
}
function closeMenu() {
layout?.classList.remove("active");
menu?.classList.remove("active");
menuLink?.classList.remove("active");
}
menuLink?.addEventListener("click", toggleMenu);
main?.addEventListener("click", () => {
if (layout?.classList.contains("active")) {
closeMenu();
}
});
}
// Run on initial load
initMenuToggle();
// Re-run on Astro page transitions
document.addEventListener("astro:after-swap", initMenuToggle);
</script>

161
src/components/Sidebar.astro Normal file
View File

@@ -0,0 +1,161 @@
---
import { config } from "../config";
interface Props {
currentVersion?: string;
}
const { currentVersion } = Astro.props;
---
<div id="menu">
<div class="menu-inner">
<ul class="menu-list">
<li class="menu-label">Versions:</li>
{
config.versions.map((version) => (
<li
class:list={[
"menu-item",
{ selected: version === currentVersion },
]}
>
<a href={`/spec/${version}`} class="menu-link-item">
{version}
</a>
</li>
))
}
</ul>
</div>
<div class="links">
<a
href={config.repoUrl}
aria-label="View on GitHub"
class="github-link"
>
<svg
class="w-12 h-12"
fill="currentColor"
viewBox="0 0 24 24"
aria-hidden="true"
>
<path
fill-rule="evenodd"
d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839
9.504.5.092.682-.217.682-.483
0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608
1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088
2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951
0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65
0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004
1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546
1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028
2.688 0 3.848-2.339 4.695-4.566
4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012
2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22
6.484 17.522 2 12 2z"
clip-rule="evenodd"></path>
</svg>
</a>
</div>
</div>
<style>
#menu {
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 0.2s ease-out;
display: flex;
flex-direction: column;
}
.menu-inner {
flex: 1;
}
.menu-list {
list-style: none;
margin: 0;
padding: 0;
border: none;
background: transparent;
border-top: 1px solid #333;
}
.menu-label {
color: #999;
border: none;
padding: 0.6em 0 0.6em 0.6em;
font-size: 0.9em;
}
.menu-item {
border: none;
}
.menu-link-item {
display: block;
color: #999;
border: none;
padding: 0.6em 0 0.6em 0.6em;
text-decoration: none;
transition: background-color 0.15s ease;
}
.menu-link-item:hover,
.menu-link-item:focus {
background: #333;
}
.menu-item.selected {
background: #1f8dd6;
}
.menu-item.selected .menu-link-item {
color: #fff;
}
.links {
font-size: 50px;
padding: 10px 0;
text-align: center;
display: flex;
flex-direction: column;
align-items: center;
gap: 0.25rem;
}
.github-link {
color: #555;
padding: 0;
position: relative;
text-decoration: none;
transition: color 0.15s ease;
}
.github-link:hover {
color: #777;
}
/* Desktop: show menu */
@media (min-width: 48em) {
#menu {
left: 150px;
}
}
/* When menu is active (mobile) */
:global(#layout.active) #menu {
left: 150px;
width: 150px;
}
</style>

31
src/config.ts Normal file
View File

@@ -0,0 +1,31 @@
export const config = {
title: "Git Common Flow",
description:
"An attempt to gather a sensible selection of the most common usage " +
"patterns of git into a single and concise specification.",
author: "Jim Myhrberg",
hostname: "commonflow.org",
url: "https://commonflow.org",
repoUrl: "https://github.com/jimeh/common-flow",
currentVersion: "1.0.0-rc.5",
versions: [
"1.0.0-rc.5",
"1.0.0-rc.4",
"1.0.0-rc.3",
"1.0.0-rc.2",
"1.0.0-rc.1",
],
// Used by update script
update: {
urlTemplate:
"https://github.com/jimeh/common-flow/raw/{{version}}/{{file}}",
files: {
document: "common-flow.md",
diagram: "common-flow.svg",
},
},
} as const;
export type Config = typeof config;

12
src/content.config.ts Normal file
View File

@@ -0,0 +1,12 @@
import { defineCollection, z } from "astro:content";
import { glob } from "astro/loaders";
const spec = defineCollection({
loader: glob({ pattern: "**/*.md", base: "./src/content/spec" }),
schema: z.object({
title: z.string(),
version: z.string(),
}),
});
export const collections = { spec };

3
spec/1.0.0-rc.1.md → src/content/spec/1.0.0-rc.1.md
View File

@@ -5,7 +5,7 @@ version: 1.0.0-rc.1
Git Common-Flow 1.0.0-rc.1 Git Common-Flow 1.0.0-rc.1
============================== ==============================
<img src="/spec/1.0.0-rc.1.svg" width="100%" /> <img src="/spec/1.0.0-rc.1.svg" alt="Git Common-Flow 1.0.0-rc.1 diagram" width="100%" />
Summary Summary
------- -------
@@ -181,4 +181,3 @@ License
------- -------
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) [Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)

3
spec/1.0.0-rc.2.md → src/content/spec/1.0.0-rc.2.md
View File

@@ -5,7 +5,7 @@ version: 1.0.0-rc.2
Git Common-Flow 1.0.0-rc.2 Git Common-Flow 1.0.0-rc.2
============================== ==============================
<img src="/spec/1.0.0-rc.2.svg" width="100%" /> <img src="/spec/1.0.0-rc.2.svg" alt="Git Common-Flow 1.0.0-rc.2 diagram" width="100%" />
Summary Summary
------- -------
@@ -206,4 +206,3 @@ License
------- -------
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) [Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)

3
spec/1.0.0-rc.3.md → src/content/spec/1.0.0-rc.3.md
View File

@@ -5,7 +5,7 @@ version: 1.0.0-rc.3
Git Common-Flow 1.0.0-rc.3 Git Common-Flow 1.0.0-rc.3
=========================== ===========================
<img src="/spec/1.0.0-rc.3.svg" width="100%" /> <img src="/spec/1.0.0-rc.3.svg" alt="Git Common-Flow 1.0.0-rc.3 diagram" width="100%" />
Summary Summary
------- -------
@@ -212,4 +212,3 @@ License
------- -------
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) [Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)

3
spec/1.0.0-rc.4.md → src/content/spec/1.0.0-rc.4.md
View File

@@ -5,7 +5,7 @@ version: 1.0.0-rc.4
Git Common-Flow 1.0.0-rc.4 Git Common-Flow 1.0.0-rc.4
=========================== ===========================
<img src="/spec/1.0.0-rc.4.svg" width="100%" /> <img src="/spec/1.0.0-rc.4.svg" alt="Git Common-Flow 1.0.0-rc.4 diagram" width="100%" />
Summary Summary
------- -------
@@ -338,4 +338,3 @@ License
------- -------
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) [Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)

3
spec/1.0.0-rc.5.md → src/content/spec/1.0.0-rc.5.md
View File

@@ -5,7 +5,7 @@ version: 1.0.0-rc.5
Git Common-Flow 1.0.0-rc.5 Git Common-Flow 1.0.0-rc.5
=========================== ===========================
<img src="/spec/1.0.0-rc.5.svg" width="100%" /> <img src="/spec/1.0.0-rc.5.svg" alt="Git Common-Flow 1.0.0-rc.5 diagram" width="100%" />
Introduction Introduction
------------ ------------
@@ -359,4 +359,3 @@ License
------- -------
[Creative Commons - CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) [Creative Commons - CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)

103
src/layouts/Default.astro Normal file
View File

@@ -0,0 +1,103 @@
---
import "../styles/global.css";
import { config } from "../config";
import Sidebar from "../components/Sidebar.astro";
import MenuToggle from "../components/MenuToggle.astro";
interface Props {
title: string;
description?: string;
version?: string;
}
const { title, description = config.description, version } = Astro.props;
const fullTitle = title === config.title ? title : `${title} | ${config.title}`;
---
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="canonical" href={Astro.url} />
<title>{fullTitle}</title>
<meta name="description" content={description} />
<meta name="author" content={config.author} />
<!-- Open Graph -->
<meta property="og:title" content={fullTitle} />
<meta property="og:description" content={description} />
<meta property="og:type" content="website" />
<meta property="og:url" content={Astro.url} />
<!-- Twitter -->
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content={fullTitle} />
<meta name="twitter:description" content={description} />
<!-- Fonts -->
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=Open+Sans+Condensed:wght@300;700&family=Open+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap"
rel="stylesheet"
/>
</head>
<body>
<div id="layout">
<MenuToggle />
<Sidebar currentVersion={version} />
<div id="main">
<div class="content">
<slot />
</div>
</div>
</div>
</body>
</html>
<style>
#layout {
position: relative;
left: 0;
padding-left: 0;
transition: all 0.2s ease-out;
}
#main {
min-height: 100vh;
}
.content {
margin: 0 auto;
padding: 0 2em;
max-width: 800px;
margin-bottom: 50px;
line-height: 1.6em;
padding-top: 80px;
}
/* Desktop layout */
@media (min-width: 48em) {
#layout {
padding-left: 150px;
left: 0;
}
.content {
padding-left: 2em;
padding-right: 2em;
}
}
/* Mobile: when menu is active */
@media (max-width: 48em) {
:global(#layout.active) {
position: relative;
left: 150px;
}
}
</style>

48
src/pages/404.astro Normal file
View File

@@ -0,0 +1,48 @@
---
import Default from "../layouts/Default.astro";
---
<Default title="Page Not Found">
<div class="not-found">
<h1>404</h1>
<p>Page not found.</p>
<p>
<a href="/">Go to the homepage</a>
</p>
</div>
</Default>
<style>
.not-found {
text-align: center;
padding-top: 4rem;
}
.not-found h1 {
font-size: 6rem;
margin-bottom: 0.5rem;
color: #999;
}
.dark .not-found h1 {
color: #666;
}
.not-found p {
font-size: 1.25rem;
margin-bottom: 1rem;
}
.not-found a {
color: #1f8dd6;
text-decoration: none;
}
.not-found a:hover {
text-decoration: underline;
}
.dark .not-found a {
color: #4da6e8;
}
</style>

21
src/pages/index.astro Normal file
View File

@@ -0,0 +1,21 @@
---
import { getCollection, render } from "astro:content";
import Default from "../layouts/Default.astro";
import { config } from "../config";
// Get all specs and find the current version
const specs = await getCollection("spec");
const currentSpec = specs.find((s) => s.data.version === config.currentVersion);
if (!currentSpec) {
return Astro.redirect("/404");
}
const { Content } = await render(currentSpec);
---
<Default title={currentSpec.data.title} version={currentSpec.data.version}>
<article class="spec-content">
<Content />
</article>
</Default>

21
src/pages/spec/[version].astro Normal file
View File

@@ -0,0 +1,21 @@
---
import { getCollection, render } from "astro:content";
import Default from "../../layouts/Default.astro";
export async function getStaticPaths() {
const specs = await getCollection("spec");
return specs.map((spec) => ({
params: { version: spec.data.version },
props: { spec },
}));
}
const { spec } = Astro.props;
const { Content } = await render(spec);
---
<Default title={spec.data.title} version={spec.data.version}>
<article class="spec-content">
<Content />
</article>
</Default>

165
src/styles/global.css Normal file
View File

@@ -0,0 +1,165 @@
@import "tailwindcss";
@plugin "@tailwindcss/typography";
@theme {
/* Colors */
--color-sidebar: #191818;
--color-sidebar-hover: #333;
--color-accent: #1f8dd6;
--color-text-primary: #1a1a1a;
--color-text-secondary: #777;
--color-text-muted: #999;
--color-bg-primary: #fdfdfd;
--color-bg-code: #f6f8fa;
--color-bg-code-inline: rgba(27, 31, 35, 0.05);
--color-border: #333;
/* Fonts */
--font-sans: "Open Sans", Helvetica, Arial, sans-serif;
--font-heading: "Open Sans Condensed", Helvetica, Arial, sans-serif;
--font-mono: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier,
monospace;
/* Sizing */
--sidebar-width: 150px;
}
/* Base styles */
@layer base {
html {
height: 100%;
}
body {
font-family: var(--font-sans);
font-size: 16px;
font-weight: 400;
line-height: 1.5;
color: var(--color-text-primary);
background-color: var(--color-bg-primary);
}
h1,
h2,
h3,
h4,
h5,
h6 {
font-family: var(--font-heading);
font-weight: 700;
color: #333;
}
h1 {
font-size: 2.5em;
line-height: 1.2;
}
/* Nested list styling */
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);
border-radius: 3px;
font-family: var(--font-mono);
font-size: 85%;
margin: 0;
padding: 0.3em 0.4em 0.1em 0.4em;
}
pre {
background-color: var(--color-bg-code);
border-radius: 3px;
line-height: 1.45;
padding: 16px;
}
pre > code {
background-color: transparent !important;
border-radius: 0;
font-size: 90%;
padding: 0;
}
}
/* Layout transitions */
@layer components {
#layout,
#menu,
.menu-link {
transition: all 0.2s ease-out;
}
/* Spec content styling */
.spec-content h1 {
margin-bottom: 0.5em;
}
.spec-content h2 {
margin-top: 2em;
margin-bottom: 0.75em;
padding-bottom: 0.3em;
border-bottom: 1px solid #eee;
}
.spec-content h3 {
margin-top: 1.5em;
margin-bottom: 0.5em;
}
.spec-content p {
margin-bottom: 1em;
}
.spec-content ul,
.spec-content ol {
margin-bottom: 1em;
padding-left: 2em;
}
.spec-content li {
margin-bottom: 0.25em;
}
.spec-content a {
color: #1f8dd6;
text-decoration: none;
}
.spec-content a:hover {
text-decoration: underline;
}
.spec-content img {
max-width: 100%;
height: auto;
margin: 1em 0;
}
.spec-content blockquote {
margin: 1em 0;
padding-left: 1em;
border-left: 4px solid #ddd;
color: #666;
}
.spec-content hr {
margin: 2em 0;
border: none;
border-top: 1px solid #eee;
}
}

5
tsconfig.json Normal file
View File

@@ -0,0 +1,5 @@
{
"extends": "astro/tsconfigs/strict",
"include": [".astro/types.d.ts", "**/*"],
"exclude": ["dist", "docs"]
}

7
wrangler.jsonc Normal file
View File

@@ -0,0 +1,7 @@
{
"name": "commonflow-org",
"compatibility_date": "2026-01-12",
"assets": {
"directory": "./docs"
}
}