8 Commits

Author SHA1 Message Date
65b73bce68 Update to version 1.0.0-rc.3 2017-07-12 14:41:41 +01:00
80ce565080 Rebuild site with Google Analytics and tidy html 2017-07-10 19:26:31 +01:00
1f5b48f5f3 Add jekyll-tidy plugin for tidy HTML output 2017-07-10 19:22:47 +01:00
4f8f4d434d Add Google Analytics 2017-07-10 19:21:45 +01:00
33c90a3c1e Switch back to latest version of jekyll
We no longer have GitHub Pages render the jekyll site for us, but
rather we generate static html into the docs folder offline. Hence we
can use whatever jekyll version we want.
2017-07-10 19:21:37 +01:00
d2689d1c79 Rebuild site with compiled and digest suffixed assets 2017-07-09 21:42:49 +01:00
d3703dba89 Enable asset compression 2017-07-09 21:40:26 +01:00
cc198331c3 Use jekyll-assets for asset compilation 2017-07-09 21:30:19 +01:00
28 changed files with 1442 additions and 1254 deletions

2
.gitignore vendored
View File

@@ -1,3 +1,5 @@
_site _site
.asset-cache
.sass-cache .sass-cache
.jekyll-metadata .jekyll-metadata
docs/assets/.sprockets-manifest-*.json

17
Gemfile
View File

@@ -1,18 +1,6 @@
source 'https://rubygems.org' source 'https://rubygems.org'
# Hello! This is where you manage which Jekyll version is used to run. gem 'jekyll', '3.5.0'
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
# gem 'jekyll', '3.5.0'
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem 'github-pages', group: :jekyll_plugins
group :development do group :development do
gem 'rake' gem 'rake'
@@ -21,9 +9,12 @@ end
# If you have any plugins, put them here! # If you have any plugins, put them here!
group :jekyll_plugins do group :jekyll_plugins do
gem 'jekyll-assets'
gem 'jekyll-pants' gem 'jekyll-pants'
gem 'jekyll-seo-tag' gem 'jekyll-seo-tag'
gem 'jekyll-sitemap' gem 'jekyll-sitemap'
gem 'jekyll-tidy'
gem 'uglifier' # required by 'jekyll-assets' for JS compression
end end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

View File

@@ -1,182 +1,65 @@
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
activesupport (4.2.8)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.5.1) addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2) public_suffix (~> 2.0, >= 2.0.2)
ast (2.3.0) ast (2.3.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
colorator (1.1.0) colorator (1.1.0)
ethon (0.10.1) concurrent-ruby (1.0.5)
ffi (>= 1.3.0)
execjs (2.7.0) execjs (2.7.0)
faraday (0.12.1) extras (0.3.0)
multipart-post (>= 1.2, < 3) forwardable-extended (~> 2.5)
fastimage (2.1.0)
ffi (1.9.18) ffi (1.9.18)
forwardable-extended (2.6.0) forwardable-extended (2.6.0)
gemoji (3.0.0) htmlbeautifier (1.3.1)
github-pages (141) htmlcompressor (0.3.1)
activesupport (= 4.2.8) jekyll (3.5.0)
github-pages-health-check (= 1.3.4)
jekyll (= 3.4.3)
jekyll-avatar (= 0.4.2)
jekyll-coffeescript (= 1.0.1)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.9.2)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 2.4.0)
jekyll-mentions (= 1.2.0)
jekyll-optional-front-matter (= 0.1.2)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.1.0)
jekyll-redirect-from (= 0.12.1)
jekyll-relative-links (= 0.4.1)
jekyll-sass-converter (= 1.5.0)
jekyll-seo-tag (= 2.2.3)
jekyll-sitemap (= 1.0.0)
jekyll-swiss (= 0.4.0)
jekyll-theme-architect (= 0.0.4)
jekyll-theme-cayman (= 0.0.4)
jekyll-theme-dinky (= 0.0.4)
jekyll-theme-hacker (= 0.0.4)
jekyll-theme-leap-day (= 0.0.4)
jekyll-theme-merlot (= 0.0.4)
jekyll-theme-midnight (= 0.0.4)
jekyll-theme-minimal (= 0.0.4)
jekyll-theme-modernist (= 0.0.4)
jekyll-theme-primer (= 0.2.1)
jekyll-theme-slate (= 0.0.4)
jekyll-theme-tactile (= 0.0.4)
jekyll-theme-time-machine (= 0.0.4)
jekyll-titles-from-headings (= 0.2.0)
jemoji (= 0.8.0)
kramdown (= 1.13.2)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
minima (= 2.1.1)
rouge (= 1.11.1)
terminal-table (~> 1.4)
github-pages-health-check (1.3.4)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 2.0)
typhoeus (~> 0.7)
html-pipeline (2.6.0)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.8.4)
jekyll (3.4.3)
addressable (~> 2.4) addressable (~> 2.4)
colorator (~> 1.0) colorator (~> 1.0)
jekyll-sass-converter (~> 1.0) jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1) jekyll-watch (~> 1.1)
kramdown (~> 1.3) kramdown (~> 1.3)
liquid (~> 3.0) liquid (~> 4.0)
mercenary (~> 0.3.3) mercenary (~> 0.3.3)
pathutil (~> 0.9) pathutil (~> 0.9)
rouge (~> 1.7) rouge (~> 1.7)
safe_yaml (~> 1.0) safe_yaml (~> 1.0)
jekyll-avatar (0.4.2) jekyll-assets (2.3.2)
jekyll (~> 3.0) concurrent-ruby (~> 1.0)
jekyll-coffeescript (1.0.1) extras (~> 0.2)
coffee-script (~> 2.2) fastimage (~> 2.0, >= 1.8)
jekyll-default-layout (0.1.4) jekyll (~> 3.1, >= 3.0)
jekyll (~> 3.0) pathutil (>= 0.8)
jekyll-feed (0.9.2) rack (~> 1.6)
jekyll (~> 3.3) sprockets (~> 3.3, < 3.8)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (2.4.0)
jekyll (~> 3.1)
octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-optional-front-matter (0.1.2)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-pants (0.2.1) jekyll-pants (0.2.1)
rubypants rubypants
jekyll-readme-index (0.1.0)
jekyll (~> 3.0)
jekyll-redirect-from (0.12.1)
jekyll (~> 3.3)
jekyll-relative-links (0.4.1)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.0) jekyll-sass-converter (1.5.0)
sass (~> 3.4) sass (~> 3.4)
jekyll-seo-tag (2.2.3) jekyll-seo-tag (2.2.3)
jekyll (~> 3.3) jekyll (~> 3.3)
jekyll-sitemap (1.0.0) jekyll-sitemap (1.0.0)
jekyll (~> 3.3) jekyll (~> 3.3)
jekyll-swiss (0.4.0) jekyll-tidy (0.2.2)
jekyll-theme-architect (0.0.4) htmlbeautifier
jekyll (~> 3.3) htmlcompressor
jekyll-theme-cayman (0.0.4) jekyll
jekyll (~> 3.3)
jekyll-theme-dinky (0.0.4)
jekyll (~> 3.3)
jekyll-theme-hacker (0.0.4)
jekyll (~> 3.3)
jekyll-theme-leap-day (0.0.4)
jekyll (~> 3.3)
jekyll-theme-merlot (0.0.4)
jekyll (~> 3.3)
jekyll-theme-midnight (0.0.4)
jekyll (~> 3.3)
jekyll-theme-minimal (0.0.4)
jekyll (~> 3.3)
jekyll-theme-modernist (0.0.4)
jekyll (~> 3.3)
jekyll-theme-primer (0.2.1)
jekyll (~> 3.3)
jekyll-theme-slate (0.0.4)
jekyll (~> 3.3)
jekyll-theme-tactile (0.0.4)
jekyll (~> 3.3)
jekyll-theme-time-machine (0.0.4)
jekyll (~> 3.3)
jekyll-titles-from-headings (0.2.0)
jekyll (~> 3.3)
jekyll-watch (1.5.0) jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1) listen (~> 3.0, < 3.1)
jemoji (0.8.0) kramdown (1.14.0)
activesupport (~> 4.0) liquid (4.0.0)
gemoji (~> 3.0) listen (3.0.8)
html-pipeline (~> 2.2) rb-fsevent (~> 0.9, >= 0.9.4)
jekyll (>= 3.0) rb-inotify (~> 0.9, >= 0.9.7)
kramdown (1.13.2)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6) mercenary (0.3.6)
mini_portile2 (2.2.0)
minima (2.1.1)
jekyll (~> 3.3)
minitest (5.10.2)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.8.0)
mini_portile2 (~> 2.2.0)
octokit (4.7.0)
sawyer (~> 0.8.0, >= 0.5.3)
parser (2.4.0.0) parser (2.4.0.0)
ast (~> 2.2) ast (~> 2.2)
pathutil (0.14.0) pathutil (0.14.0)
forwardable-extended (~> 2.6) forwardable-extended (~> 2.6)
powerpack (0.1.1) powerpack (0.1.1)
public_suffix (2.0.5) public_suffix (2.0.5)
rack (1.6.8)
rainbow (2.2.1) rainbow (2.2.1)
rake (12.0.0) rake (12.0.0)
rb-fsevent (0.10.2) rb-fsevent (0.10.2)
@@ -192,30 +75,28 @@ GEM
ruby-progressbar (1.8.1) ruby-progressbar (1.8.1)
rubypants (0.6.0) rubypants (0.6.0)
safe_yaml (1.0.4) safe_yaml (1.0.4)
sass (3.4.24) sass (3.4.25)
sawyer (0.8.1) sprockets (3.7.1)
addressable (>= 2.3.5, < 2.6) concurrent-ruby (~> 1.0)
faraday (~> 0.8, < 1.0) rack (> 1, < 3)
terminal-table (1.8.0) uglifier (3.2.0)
unicode-display_width (~> 1.1, >= 1.1.1) execjs (>= 0.3.0, < 3)
thread_safe (0.3.6)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.3)
thread_safe (~> 0.1)
unicode-display_width (1.3.0) unicode-display_width (1.3.0)
PLATFORMS PLATFORMS
ruby ruby
DEPENDENCIES DEPENDENCIES
github-pages jekyll (= 3.5.0)
jekyll-assets
jekyll-pants jekyll-pants
jekyll-seo-tag jekyll-seo-tag
jekyll-sitemap jekyll-sitemap
jekyll-tidy
rake rake
rubocop rubocop
tzinfo-data tzinfo-data
uglifier
BUNDLED WITH BUNDLED WITH
1.14.6 1.14.6

2
_assets/css/main.scss Normal file
View File

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

1
_assets/js/main.js Normal file
View File

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

44
_assets/js/ui.js Normal file
View File

@@ -0,0 +1,44 @@
(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));

View File

@@ -3,10 +3,12 @@ description: >
An attempt to gather a sensible selection of the most common usage patterns of An attempt to gather a sensible selection of the most common usage patterns of
git into a single and concise specification. git into a single and concise specification.
author: Jim Myhrberg author: Jim Myhrberg
hostname: commonflow.org
url: https://commonflow.org url: https://commonflow.org
current_version: 1.0.0-rc.2 current_version: 1.0.0-rc.3
versions: versions:
- 1.0.0-rc.3
- 1.0.0-rc.2 - 1.0.0-rc.2
- 1.0.0-rc.1 - 1.0.0-rc.1
@@ -30,10 +32,12 @@ update:
document: common-flow.md document: common-flow.md
diagram: common-flow.svg diagram: common-flow.svg
gems: plugins:
- jekyll-assets
- jekyll-pants - jekyll-pants
- jekyll-sitemap - jekyll-sitemap
- jekyll-seo-tag - jekyll-seo-tag
- jekyll-tidy
defaults: defaults:
- -
@@ -42,6 +46,12 @@ defaults:
values: values:
layout: "default" layout: "default"
assets:
digest: true
compress:
css: true
js: true
markdown: kramdown markdown: kramdown
kramdown: kramdown:
input: Pantsdown # disable smart quotes typographic symbols input: Pantsdown # disable smart quotes typographic symbols

10
_includes/analytics.html Normal file
View File

@@ -0,0 +1,10 @@
<script>
if (window.location.hostname == "{{ site.hostname }}") {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102330905-1', 'auto');
ga('send', 'pageview');
} else { _gaq = []; };
</script>

View File

@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"> <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 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://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="/css/main.css"> {% css main %}
{% seo %} {% seo %}
</head> </head>
<body> <body>
@@ -43,6 +43,7 @@
</div> </div>
</div> </div>
</div> </div>
<script src="/js/ui.js"></script> {% js main %}
{% include analytics.html %}
</body> </body>
</html> </html>

View File

@@ -1,9 +0,0 @@
---
layout: none
---
// Import partials from `sass_dir` (defaults to `_sass`)
@import
"side-menu",
"base"
;

View File

@@ -6,21 +6,21 @@
<meta name="viewport" content="width=device-width, initial-scale=1"> <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 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://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="/css/main.css"> <link type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css">
<!-- Begin Jekyll SEO tag v2.2.3 --> <!-- Begin Jekyll SEO tag v2.2.3 -->
<title>404 Page Not Found | Git Common Flow</title> <title>404 Page Not Found | Git Common Flow</title>
<meta property="og:title" content="404 Page Not Found" /> <meta property="og:title" content="404 Page Not Found" />
<meta name="author" content="Jim Myhrberg" /> <meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" /> <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 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." /> <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" /> <link rel="canonical" href="https://commonflow.org/404.html" />
<meta property="og:url" content="https://commonflow.org/404.html" /> <meta property="og:url" content="https://commonflow.org/404.html" />
<meta property="og:site_name" content="Git Common Flow" /> <meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json"> <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> {"@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"}
<!-- End Jekyll SEO tag --> </script>
<!-- End Jekyll SEO tag -->
</head> </head>
<body> <body>
<div id="layout"> <div id="layout">
@@ -33,42 +33,38 @@
<li class="pure-menu-item"> <li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div> <div class="pure-menu-label">Versions:</div>
</li> </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.2"> <li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a> <a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li> </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> </ul>
</div> </div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
<div class="header"> <div class="header">
<h1>404</h1> <h1>404</h1>
<p><strong>Page not found :(</strong></p> <p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p> <p>The requested page could not be found.</p>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<script src="/js/ui.js"></script> <script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
<script>
if (window.location.hostname == "commonflow.org") {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102330905-1', 'auto');
ga('send', 'pageview');
} else { _gaq = []; };
</script>
</body> </body>
</html> </html>

View File

@@ -0,0 +1 @@
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}

View File

@@ -0,0 +1 @@
!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);

View File

@@ -1,123 +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; } }
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; }

View File

@@ -6,21 +6,21 @@
<meta name="viewport" content="width=device-width, initial-scale=1"> <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 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://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="/css/main.css"> <link type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css">
<!-- Begin Jekyll SEO tag v2.2.3 --> <!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.2 | Git Common Flow</title> <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.2" /> <meta property="og:title" content="Git Common-Flow 1.0.0-rc.3" />
<meta name="author" content="Jim Myhrberg" /> <meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" /> <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 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." /> <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/" /> <link rel="canonical" href="https://commonflow.org/" />
<meta property="og:url" content="https://commonflow.org/" /> <meta property="og:url" content="https://commonflow.org/" />
<meta property="og:site_name" content="Git Common Flow" /> <meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json"> <script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebSite","name":"Git Common Flow","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/"}</script> {"@context":"http://schema.org","@type":"WebSite","name":"Git Common Flow","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/"}
<!-- End Jekyll SEO tag --> </script>
<!-- End Jekyll SEO tag -->
</head> </head>
<body> <body>
<div id="layout"> <div id="layout">
@@ -33,270 +33,260 @@
<li class="pure-menu-item"> <li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div> <div class="pure-menu-label">Versions:</div>
</li> </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.2 pure-menu-selected"> <li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a> <a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li> </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> </ul>
</div> </div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
<h1 id="git-common-flow-100-rc2">Git Common-Flow 1.0.0-rc.2</h1> <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>
<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
<h2 id="summary">Summary</h2> 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>
<p>Common-Flow is an attempt to gather a sensible selection of the most common of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
usage patterns of git into a single and concise specification. It is based on into account how a lot of open source projects use git.</p>
the <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a> <p>In short, Common-Flow is essentially GitHub Flow with the addition of versioned
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking releases, optional release branches, and without the requirement to deploy to
into account how a lot of open source projects use git.</p> production all the time.</p>
<h2 id="terminology">Terminology</h2>
<p>TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned <ul>
releases, maintenance releases for old versions, and without the requirement to <li><strong>Master Branch</strong> - Must be named "master", must always have passing tests,
deploy to production all the time.</p> 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
<h2 id="terminology">Terminology</h2> bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
<ul> changes in the source branch should be incorporated into the change branch via
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding rebasing.</li>
edge, and must be named <code class="highlighter-rouge">master</code>.</li> <li><strong>Merge Target</strong> - A branch that is the intended merge target for a change
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a branch. Typically the merge target branch will be the same as the source
bug fix, etc.</li> branch.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New <li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
changes in the source branch should be incorporated into the change branch via its merge target, allowing others to review, discuss and approve the changes.</li>
rebasing.</li> <li><strong>Release</strong> - May be considered safe to use in production
<li><strong>Merge Target</strong> - A branch that is the intended merge target for a change environments. Consists of a version bump commit, and a git tag named according
branch. Typically the merge target branch will be the same as the source to the new version string placed on said commit.</li>
branch.</li> <li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to also for long-term maintenance of older version.</li>
its merge target, allowing others to review, discuss and approve the changes.</li> </ul>
<li><strong>Release</strong> - Consists of a version bump commit, and a git tag named according <h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
to the new version string placed on said commit.</li> <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
also for long-term maintenance of older version.</li> interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
</ul> <ol>
<li>TL;DR
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2> <ol>
<li>Don't break the master branch.</li>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", <li>A release is a git tag.</li>
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be </ol>
interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p> </li>
<li>The Master Branch
<ol> <ol>
<li>The Master Branch <li>A branch named "master" MUST exist and it MUST be referred to as the
<ol> "master branch".</li>
<li>A branch named "master" MUST exist and it MUST be referred to as the <li>The master branch MUST always be in a non-broken state with its test
"master branch".</li> suite passing.</li>
<li>The master branch MUST be considered bleeding edge.</li> <li>The master branch IS NOT guaranteed to always work in production
<li>The master branch MUST always be in a non-broken state with its test environments. Despite test suites passing it may at times contain
suite passing.</li> 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 <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/production" state to reduce any friction with creating a new
release.</li> release.</li>
</ol> </ol>
</li> </li>
<li>Change Branches <li>Change Branches
<ol> <ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate <li>Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as "change branches". All change branches that SHOULD be referred to as "change branches". All change
branches MUST have descriptive names. It is RECOMMENDED that you commit branches MUST have descriptive names. It is RECOMMENDED that you commit
often locally, and you SHOULD regularly push your work to the same named often locally, and you SHOULD regularly push your work to the same named
branch on the remote server.</li> branch on the remote server.</li>
<li>You MUST create separate change branches for each distinctly different <li>You MUST create separate change branches for each distinctly different
change. You MUST NOT include multiple unrelated changes into a single change. You MUST NOT include multiple unrelated changes into a single
change branch.</li> change branch.</li>
<li>When a change branch is created, the branch that it is created from <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 SHOULD be referred to as the "source branch". Each change branch also
needs a designated "merge target" branch, typically this will be the same needs a designated "merge target" branch, typically this will be the same
as the source branch.</li> as the source branch.</li>
<li>Change branches MUST be regularly updated with any changes from their <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 source branch. This MUST be done by rebasing the change branch on top of
the source branch.</li> the source branch.</li>
<li>After rebasing a change branch on top of its source branch you MUST push <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 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> force push, and you SHOULD use the "--force-with-lease" git push option.</li>
</ol> </ol>
</li> </li>
<li>Pull Requests <li>Pull Requests
<ol> <ol>
<li>To merge a change branch into its merge target, you MUST open a "pull <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> 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 <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 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 happy with the change. This is especially important if the merge target
is the master branch.</li> is the master branch.</li>
<li>To get feedback, help, or generally just discuss a change branch with <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 others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li> discuss the changes with others there.</li>
</ol> </ol>
</li> </li>
<li>Versioning <li>Versioning
<ol> <ol>
<li>The project MUST have its version hard-coded somewhere in the <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" code-base. It is RECOMMENDED that this is done in a file called "VERSION"
located in the root of the project.</li> located in the root of the project.</li>
<li>If you are using a "VERSION" file in the root of the project, this MUST <li>If you are using a "VERSION" file in the root of the project, this MUST
only contain the exact version string.</li> only contain the exact version string.</li>
<li>The version string SHOULD follow the Semantic Versioning <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, (<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" but the version string MUST NOT have a "v" prefix. For example "v2.11.4"
is bad, and "2.11.4" is good.</li> is bad, and "2.11.4" is good.</li>
</ol> </ol>
</li> </li>
<li>Releases <li>Releases
<ol> <ol>
<li>To create a new release, you MUST create a "version bump" commit which <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 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 commit MUST have a git tag created on it and named as the exact version
string.</li> string.</li>
<li>If you are not using a release branch, then the version bump commit MUST <li>If you are not using a release branch, then the version bump commit MUST
be created directly on the master branch.</li> be created directly on the master branch.</li>
<li>The version bump commit MUST have a commit message title of "Bump version <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 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> 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 <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 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 "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 MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form
and stick to it.</li> and stick to it.</li>
<li>It is RECOMMENDED that release tags are lightweight tags, but you can <li>It is RECOMMENDED that release tags are lightweight tags, but you can
OPTIONALLY use annotated tags if you want to include changelog OPTIONALLY use annotated tags if you want to include changelog
information in the release tag itself.</li> information in the release tag itself.</li>
<li>If you use annotated release tags, the first line of the annotation MUST <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 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 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> be blank, and the changelog MUST start on the third line.</li>
</ol> </ol>
</li> </li>
<li>Release Branches <li>Release Branches
<ol> <ol>
<li>Any branch that has a name starting with "release-" SHOULD be referred to <li>Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".</li> as a "release branch".</li>
<li>Use of release branches is OPTIONAL.</li> <li>Use of release branches is OPTIONAL.</li>
<li>Changes in a release branch SHOULD typically come from work being <li>Changes in a release branch SHOULD typically come from work being
done against the master branch. Meaning changes SHOULD only trickle done against the master branch. Meaning changes SHOULD only trickle
downwards from the master branch. If a change needs to trickle back up 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 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> 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>There are two types of release branches; short-term, and long-term.</li>
<li>Short-Term Release Branches <li>Short-Term Release Branches
<ol> <ol>
<li>Used for creating a specific versioned release.</li> <li>Used for creating a specific versioned release.</li>
<li>A short-term release branch is RECOMMENDED if there is a lengthy <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 pre-release verification process to avoid a code freeze on the master
branch.</li> branch.</li>
<li>MUST have a name of "release-VERSION". For example for version <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> "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 <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> 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 <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 directly. Any larger changes SHOULD be done in the master
branch, and SHOULD be pulled into the release branch by rebasing it 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 on top of the master branch the same way a change branch pulls in
updates from its source branch.</li> updates from its source branch.</li>
<li>After the version bump commit and release tag have been created, the <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 release branch MUST be merged back into its source branch and then
deleted. Typically the source branch will be the master branch.</li> deleted. Typically the source branch will be the master branch.</li>
</ol> </ol>
</li> </li>
<li>Long-Term Release Branches <li>Long-Term Release Branches
<ol> <ol>
<li>Used for work on versions which are not currently part of the master <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 branch. Typically this is useful when you need to create a new
maintenance release for a older version.</li> maintenance release for a older version.</li>
<li>The branch name MUST have a non-specific version number. For example <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 a long-term release branch for creating new 2.9.x releases would be
named "release-2.9".</li> named "release-2.9".</li>
<li>To create a new release from a long-term release branch, you MUST <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 create a version bump commit and release tag directly on the release
branch.</li> branch.</li>
<li>A long-term release branch MUST be created from the relevant release <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 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 is a security fix for all 2.9.x releases, the latest of which is
"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7"
release tag. The security fix release will then end up being version release tag. The security fix release will then end up being version
"2.9.8".</li> "2.9.8".</li>
</ol> </ol>
</li> </li>
</ol> </ol>
</li> </li>
<li>Bug Fixes &amp; Rollback <li>Bug Fixes &amp; Rollback
<ol> <ol>
<li>You MUST NOT under any circumstances force push to the master branch.</li> <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 <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 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 change branch and MUST follow the same workflow as any other change
branch.</li> branch.</li>
<li>If a change branch is wrongfully merged into master, or for any other <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 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 merge commit itself. Effectively creating a new commit that reverses all
the relevant changes.</li> the relevant changes.</li>
</ol> </ol>
</li> </li>
<li>Git Best Practices <li>Git Best Practices
<ol> <ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from <li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git the official git
documentation: 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> <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 <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 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> 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 <li>You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More regular "--force" option is dangerous and destructive. More
information: 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> <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 <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> 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 <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 pull" to avoid unnecessary merge commits. You can make this the default
behavior of "git pull" with "git config --global pull.rebase true".</li> 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". <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 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, 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 and creates a merge commit to mark the integration of the branch with
master.</li> master.</li>
</ol> </ol>
</li> </li>
</ol> </ol>
<h2 id="about">About</h2>
<h2 id="about">About</h2> <p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>The Git Common-Flow specification is authored <p>If you'd like to leave feedback,
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p> please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p>If you'd like to leave feedback, <p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
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> </div>
</div> </div>
<script src="/js/ui.js"></script> <script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
<script>
if (window.location.hostname == "commonflow.org") {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102330905-1', 'auto');
ga('send', 'pageview');
} else { _gaq = []; };
</script>
</body> </body>
</html> </html>

View File

@@ -1,46 +0,0 @@
(function (window, document) {
var layout = document.getElementById('layout'),
menu = document.getElementById('menu'),
menuLink = document.getElementById('menuLink'),
content = document.getElementById('main');
function toggleClass(element, className) {
var classes = element.className.split(/\s+/),
length = classes.length,
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));

View File

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

View File

@@ -1,12 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?> <?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"> <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> <url>
<loc>https://commonflow.org/spec/1.0.0-rc.1.html</loc> <loc>https://commonflow.org/spec/1.0.0-rc.1.html</loc>
</url> </url>
<url> <url>
<loc>https://commonflow.org/spec/1.0.0-rc.2.html</loc> <loc>https://commonflow.org/spec/1.0.0-rc.2.html</loc>
</url> </url>
<url> <url>
<loc>https://commonflow.org/</loc> <loc>https://commonflow.org/spec/1.0.0-rc.3.html</loc>
</url> </url>
</urlset> <url>
<loc>https://commonflow.org/</loc>
</url>
</urlset>

View File

@@ -6,21 +6,21 @@
<meta name="viewport" content="width=device-width, initial-scale=1"> <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 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://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="/css/main.css"> <link type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css">
<!-- Begin Jekyll SEO tag v2.2.3 --> <!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.1 | Git Common Flow</title> <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 property="og:title" content="Git Common-Flow 1.0.0-rc.1" />
<meta name="author" content="Jim Myhrberg" /> <meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" /> <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 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." /> <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" /> <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:url" content="https://commonflow.org/spec/1.0.0-rc.1.html" />
<meta property="og:site_name" content="Git Common Flow" /> <meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json"> <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> {"@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"}
<!-- End Jekyll SEO tag --> </script>
<!-- End Jekyll SEO tag -->
</head> </head>
<body> <body>
<div id="layout"> <div id="layout">
@@ -33,236 +33,217 @@
<li class="pure-menu-item"> <li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div> <div class="pure-menu-label">Versions:</div>
</li> </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.2"> <li class="pure-menu-item version-1.0.0-rc.1 pure-menu-selected">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a> <a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li> </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> </ul>
</div> </div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
<h1 id="git-common-flow-100-rc1">Git Common-Flow 1.0.0-rc.1</h1> <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>
<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
<h2 id="summary">Summary</h2> 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>
<p>Common-Flow is an attempt to gather a sensible selection of the most common of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
usage patterns of git into a single and concise specification. It is based on into account how a lot of open source projects use git.</p>
the <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a> <p>TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking releases, maintenance releases for old versions, and without the requirement to
into account how a lot of open source projects use git.</p> deploy to production all the time.</p>
<h2 id="terminology">Terminology</h2>
<p>TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned <ul>
releases, maintenance releases for old versions, and without the requirement to <li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding
deploy to production all the time.</p> 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
<h2 id="terminology">Terminology</h2> bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
<ul> changes in the source branch should be incorporated into the change branch via
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding rebasing.</li>
edge, and must be named <code class="highlighter-rouge">master</code>.</li> <li><strong>Merge Target</strong> - A branch that is the intended merge target for a change
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a branch. Typically the merge target branch will be the same as the source
bug fix, etc.</li> branch.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New <li><strong>Maintenance Branches</strong> - Used for maintaining old versions and releasing
changes in the source branch should be incorporated into the change branch via PATCH updates when the master branch has moved on. Should follow a
rebasing.</li> <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
<li><strong>Merge Target</strong> - A branch that is the intended merge target for a change version.</li>
branch. Typically the merge target branch will be the same as the source <li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
branch.</li> its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Maintenance Branches</strong> - Used for maintaining old versions and releasing <li><strong>Release</strong> - Consists of a version bump commit directly on the master branch,
PATCH updates when the master branch has moved on. Should follow a and a git tag named according to the new version string placed on said commit.</li>
<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 <li><strong>Maintenance Release</strong> - Just like a regular release, except the version bump
version.</li> commit and release tag are on a maintenance branch instead of the master
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to branch.</li>
its merge target, allowing others to review, discuss and approve the changes.</li> </ul>
<li><strong>Release</strong> - Consists of a version bump commit directly on the master branch, <h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
and a git tag named according to the new version string placed on said commit.</li> <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
<li><strong>Maintenance Release</strong> - Just like a regular release, except the version bump "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
commit and release tag are on a maintenance branch instead of the master interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
branch.</li> <ol>
</ul> <li>The Master Branch
<ol>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2> <li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", <li>The master branch MUST be considered bleeding edge.</li>
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be <li>The master branch MUST always be in a non-broken state with its test
interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p> suite passing.</li>
<li>The master branch SHOULD always be in a "as near as possible ready for
<ol> release/production" state to reduce the friction of creating a new
<li>The Master Branch release.</li>
<ol> </ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the </li>
"master branch".</li> <li>Changes
<li>The master branch MUST be considered bleeding edge.</li> <ol>
<li>The master branch MUST always be in a non-broken state with its test <li>Changes MUST be performed on a separate branch that SHOULD be referred to
suite passing.</li> as a "change branch". All change branches MUST have descriptive names. It
<li>The master branch SHOULD always be in a "as near as possible ready for is RECOMMENDED that you commit often locally, and you SHOULD regularly
release/production" state to reduce the friction of creating a new push your work to the same named branch on the remote server.</li>
release.</li> <li>When a change branch is created, the branch that it is created from
</ol> SHOULD be referred to as the "source branch". Each change branch also
</li> needs a designated "merge target branch", typically this will be the same
<li>Changes as the source branch.</li>
<ol> <li>Change branches MUST be regularly updated with any changes from their
<li>Changes MUST be performed on a separate branch that SHOULD be referred to source branch. This MUST be done by rebasing the change branch on top of
as a "change branch". All change branches MUST have descriptive names. It the source branch. To be clear you MUST NOT merge a source branch into a
is RECOMMENDED that you commit often locally, and you SHOULD regularly change branch.</li>
push your work to the same named branch on the remote server.</li> <li>After rebasing a change branch on top of its source branch you MUST push
<li>When a change branch is created, the branch that it is created from the change branch to the remote server. This will require you do a force
SHOULD be referred to as the "source branch". Each change branch also push, and you SHOULD use the "--force-with-lease" git push option.</li>
needs a designated "merge target branch", typically this will be the same <li>To merge a change branch into its merge target branch, you MUST open a
as the source branch.</li> "pull request" (or equivalent) so others can review and approve your
<li>Change branches MUST be regularly updated with any changes from their changes.</li>
source branch. This MUST be done by rebasing the change branch on top of <li>A pull request MUST only be merged when the change branch is up-to-date
the source branch. To be clear you MUST NOT merge a source branch into a with its source branch, the test suite is passing, and you and others are
change branch.</li> happy with the change. This is especially important if the merge target
<li>After rebasing a change branch on top of its source branch you MUST push is the master branch.</li>
the change branch to the remote server. This will require you do a force <li>To get feedback, help, or generally just discuss a change branch with
push, and you SHOULD use the "--force-with-lease" git push option.</li> others, it is RECOMMENDED you do this by creating a pull request and
<li>To merge a change branch into its merge target branch, you MUST open a discuss the changes with others there.</li>
"pull request" (or equivalent) so others can review and approve your </ol>
changes.</li> </li>
<li>A pull request MUST only be merged when the change branch is up-to-date <li>Git Best Practices
with its source branch, the test suite is passing, and you and others are <ol>
happy with the change. This is especially important if the merge target <li>All commit messages SHOULD follow the Commit Guidelines and format from
is the master branch.</li> the official git
<li>To get feedback, help, or generally just discuss a change branch with documentation:
others, it is RECOMMENDED you do this by creating a pull request and <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>
discuss the changes with others there.</li> <li>You SHOULD always use "--force-with-lease" when doing a force push. The
</ol> plain "--force" option is dangerous and destructive. More
</li> information:
<li>Git Best Practices <a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<ol> <li>You SHOULD understand and be comfortable with
<li>All commit messages SHOULD follow the Commit Guidelines and format from 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>
the official git <li>It is RECOMMENDED that you always do "git pull --rebase" instead of "git
documentation: pull" to avoid unnecessary merge commits. You can make this the default
<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> behavior of "git pull" with "git config --global pull.rebase true".</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The <li>It is RECOMMENDED that all branches be merged using "git merge --no-ff".
plain "--force" option is dangerous and destructive. More This makes sure the reference to the original branch is kept in the commits,
information: allows one to revert a merge by reverting a single merge commit, and creates
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li> a merge commit to mark the integration of the branch with master.</li>
<li>You SHOULD understand and be comfortable with </ol>
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>
<li>It is RECOMMENDED that you always do "git pull --rebase" instead of "git <li>Versioning
pull" to avoid unnecessary merge commits. You can make this the default <ol>
behavior of "git pull" with "git config --global pull.rebase true".</li> <li>The project MUST have its version hard-coded somewhere in the
<li>It is RECOMMENDED that all branches be merged using "git merge --no-ff". code-base. It is RECOMMENDED that this is done in a file called "VERSION"
This makes sure the reference to the original branch is kept in the commits, located in the root of the project.</li>
allows one to revert a merge by reverting a single merge commit, and creates <li>If you are using a "VERSION" file in the root of the project, this MUST
a merge commit to mark the integration of the branch with master.</li> only contain the exact version string.</li>
</ol> <li>The version string SHOULD follow the Semantic Versioning
</li> (<a href="http://semver.org/">http://semver.org/</a>) format. Use of Semantic Versioning is OPTIONAL,
<li>Versioning but the version string MUST NOT have a "v" prefix. For example "v2.11.4"
<ol> is bad, and "2.11.4" is good.</li>
<li>The project MUST have its version hard-coded somewhere in the </ol>
code-base. It is RECOMMENDED that this is done in a file called "VERSION" </li>
located in the root of the project.</li> <li>Releases
<li>If you are using a "VERSION" file in the root of the project, this MUST <ol>
only contain the exact version string.</li> <li>To create a new release, you MUST create a "version bump" commit directly
<li>The version string SHOULD follow the Semantic Versioning on the master branch which changes the hard-coded version value of the
(<a href="http://semver.org/">http://semver.org/</a>) format. Use of Semantic Versioning is OPTIONAL, project. The version bump commit MUST have a git tag created on it and
but the version string MUST NOT have a "v" prefix. For example "v2.11.4" named as the exact version string.</li>
is bad, and "2.11.4" is good.</li> <li>A version bump commit MUST have a commit message title of "Bump version
</ol> to VERSION". For example, if the new version string is "2.11.4", the
</li> first line of the commit message MUST read: "Bump version to 2.11.4"</li>
<li>Releases <li>The release tag on the version bump commit MUST be named exactly the same
<ol> as the version string. The tag name can OPTIONALLY be prefixed with
<li>To create a new release, you MUST create a "version bump" commit directly "v". For example the tag name can be either "2.11.4" or "v2.11.4".</li>
on the master branch which changes the hard-coded version value of the <li>It is RECOMMENDED that release tags are lightweight tags, but you can
project. The version bump commit MUST have a git tag created on it and OPTIONALLY use annotated tags if you want to include changelog
named as the exact version string.</li> information in the release tag itself.</li>
<li>A version bump commit MUST have a commit message title of "Bump version <li>If you use annotated release tags, the first line of the annotation MUST
to VERSION". For example, if the new version string is "2.11.4", the read "Release VERSION". For example for version "2.11.4" the first line
first line of the commit message MUST read: "Bump version to 2.11.4"</li> of the tag annotation would read "Release 2.11.4". The second line must
<li>The release tag on the version bump commit MUST be named exactly the same be blank, and the changelog MUST start on the third line.</li>
as the version string. The tag name can OPTIONALLY be prefixed with </ol>
"v". For example the tag name can be either "2.11.4" or "v2.11.4".</li> </li>
<li>It is RECOMMENDED that release tags are lightweight tags, but you can <li>Bug Fixes &amp; Rollback
OPTIONALLY use annotated tags if you want to include changelog <ol>
information in the release tag itself.</li> <li>You MUST NOT under any circumstances force push to the master branch.</li>
<li>If you use annotated release tags, the first line of the annotation MUST <li>If a change branch which has been merged in to the master branch is found
read "Release VERSION". For example for version "2.11.4" the first line to have a bug in it, the bug fix work MUST be done as a new separate
of the tag annotation would read "Release 2.11.4". The second line must change branch and MUST follow the same workflow as any other change
be blank, and the changelog MUST start on the third line.</li> branch.</li>
</ol> <li>If a change branch is wrongfully merged in to master, or for any other
</li> reason the merge must be undone, you MUST undo the merge by reverting the
<li>Bug Fixes &amp; Rollback merge commit itself. Effectively creating a new commit that reverses all
<ol> the relevant changes.</li>
<li>You MUST NOT under any circumstances force push to the master branch.</li> </ol>
<li>If a change branch which has been merged in to the master branch is found </li>
to have a bug in it, the bug fix work MUST be done as a new separate <li>Maintenance Releases
change branch and MUST follow the same workflow as any other change <ol>
branch.</li> <li>Any branch that has a name starting with "stable-" SHOULD be referred to
<li>If a change branch is wrongfully merged in to master, or for any other as a "maintenance branch".</li>
reason the merge must be undone, you MUST undo the merge by reverting the <li>Maintenance branches are used for managing new releases of older
merge commit itself. Effectively creating a new commit that reverses all versions. Typically this is used to provide security updates for older
the relevant changes.</li> versions when the master branch has moved on to a point that a new
</ol> release for the old version cannot be made from the master branch.</li>
</li> <li>A "maintenance release" is identical to a regular release, except the
<li>Maintenance Releases version bump commit and the release tag are placed on the maintenance
<ol> branch instead of on the master branch.</li>
<li>Any branch that has a name starting with "stable-" SHOULD be referred to <li>A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where
as a "maintenance branch".</li> "X" is the MAJOR version and "Y" is the minor version.</li>
<li>Maintenance branches are used for managing new releases of older <li>A maintenance branch MUST be created from the relevant release tag. For
versions. Typically this is used to provide security updates for older example if there is a security fix for all 2.9.x releases, the latest of
versions when the master branch has moved on to a point that a new which is "2.9.7", we create a new branch called "stable-2.9" off of the
release for the old version cannot be made from the master branch.</li> "2.9.7" release tag. The security fix release will then end up being
<li>A "maintenance release" is identical to a regular release, except the version "2.9.8".</li>
version bump commit and the release tag are placed on the maintenance <li>When working on a maintenance release, the relevant maintenance branch
branch instead of on the master branch.</li> MUST be thought of as the master branch for that maintenance work.</li>
<li>A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where <li>Changes in a maintenance branch SHOULD typically come from work being
"X" is the MAJOR version and "Y" is the minor version.</li> done against the master branch. Meaning changes SHOULD only trickle
<li>A maintenance branch MUST be created from the relevant release tag. For downwards from the master branch. If a change needs to trickle back up
example if there is a security fix for all 2.9.x releases, the latest of into the master branch, that work should have happened against the master
which is "2.9.7", we create a new branch called "stable-2.9" off of the branch in the first place.</li>
"2.9.7" release tag. The security fix release will then end up being </ol>
version "2.9.8".</li> </li>
<li>When working on a maintenance release, the relevant maintenance branch </ol>
MUST be thought of as the master branch for that maintenance work.</li> <h2 id="about">About</h2>
<li>Changes in a maintenance branch SHOULD typically come from work being <p>The Git Common-Flow specification is authored
done against the master branch. Meaning changes SHOULD only trickle by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
downwards from the master branch. If a change needs to trickle back up <p>If you'd like to leave feedback,
into the master branch, that work should have happened against the master please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
branch in the first place.</li> <h2 id="license">License</h2>
</ol> <p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</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> </div>
</div> </div>
<script src="/js/ui.js"></script> <script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
<script>
if (window.location.hostname == "commonflow.org") {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102330905-1', 'auto');
ga('send', 'pageview');
} else { _gaq = []; };
</script>
</body> </body>
</html> </html>

View File

@@ -6,21 +6,21 @@
<meta name="viewport" content="width=device-width, initial-scale=1"> <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 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://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="/css/main.css"> <link type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css">
<!-- Begin Jekyll SEO tag v2.2.3 --> <!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.2 | Git Common Flow</title> <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 property="og:title" content="Git Common-Flow 1.0.0-rc.2" />
<meta name="author" content="Jim Myhrberg" /> <meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" /> <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 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." /> <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" /> <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:url" content="https://commonflow.org/spec/1.0.0-rc.2.html" />
<meta property="og:site_name" content="Git Common Flow" /> <meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json"> <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> {"@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"}
<!-- End Jekyll SEO tag --> </script>
<!-- End Jekyll SEO tag -->
</head> </head>
<body> <body>
<div id="layout"> <div id="layout">
@@ -33,270 +33,251 @@
<li class="pure-menu-item"> <li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div> <div class="pure-menu-label">Versions:</div>
</li> </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.2 pure-menu-selected"> <li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a> <a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li> </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> </ul>
</div> </div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
<h1 id="git-common-flow-100-rc2">Git Common-Flow 1.0.0-rc.2</h1> <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>
<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
<h2 id="summary">Summary</h2> 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>
<p>Common-Flow is an attempt to gather a sensible selection of the most common of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
usage patterns of git into a single and concise specification. It is based on into account how a lot of open source projects use git.</p>
the <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a> <p>TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking releases, maintenance releases for old versions, and without the requirement to
into account how a lot of open source projects use git.</p> deploy to production all the time.</p>
<h2 id="terminology">Terminology</h2>
<p>TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned <ul>
releases, maintenance releases for old versions, and without the requirement to <li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding
deploy to production all the time.</p> 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
<h2 id="terminology">Terminology</h2> bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
<ul> changes in the source branch should be incorporated into the change branch via
<li><strong>Master Branch</strong> - Must always have passing tests, is considered bleeding rebasing.</li>
edge, and must be named <code class="highlighter-rouge">master</code>.</li> <li><strong>Merge Target</strong> - A branch that is the intended merge target for a change
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a branch. Typically the merge target branch will be the same as the source
bug fix, etc.</li> branch.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New <li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
changes in the source branch should be incorporated into the change branch via its merge target, allowing others to review, discuss and approve the changes.</li>
rebasing.</li> <li><strong>Release</strong> - Consists of a version bump commit, and a git tag named according
<li><strong>Merge Target</strong> - A branch that is the intended merge target for a change to the new version string placed on said commit.</li>
branch. Typically the merge target branch will be the same as the source <li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
branch.</li> also for long-term maintenance of older version.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to </ul>
its merge target, allowing others to review, discuss and approve the changes.</li> <h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<li><strong>Release</strong> - Consists of a version bump commit, and a git tag named according <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
to the new version string placed on said commit.</li> "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
also for long-term maintenance of older version.</li> <ol>
</ul> <li>The Master Branch
<ol>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2> <li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", <li>The master branch MUST be considered bleeding edge.</li>
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be <li>The master branch MUST always be in a non-broken state with its test
interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p> suite passing.</li>
<li>The master branch SHOULD always be in a "as near as possibly ready for
<ol> release/production" state to reduce any friction with creating a new
<li>The Master Branch release.</li>
<ol> </ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the </li>
"master branch".</li> <li>Change Branches
<li>The master branch MUST be considered bleeding edge.</li> <ol>
<li>The master branch MUST always be in a non-broken state with its test <li>Each change (feature, bugfix, etc.) MUST be performed on separate
suite passing.</li> branches that SHOULD be referred to as "change branches". All change
<li>The master branch SHOULD always be in a "as near as possibly ready for branches MUST have descriptive names. It is RECOMMENDED that you commit
release/production" state to reduce any friction with creating a new often locally, and you SHOULD regularly push your work to the same named
release.</li> branch on the remote server.</li>
</ol> <li>You MUST create separate change branches for each distinctly different
</li> change. You MUST NOT include multiple unrelated changes into a single
<li>Change Branches change branch.</li>
<ol> <li>When a change branch is created, the branch that it is created from
<li>Each change (feature, bugfix, etc.) MUST be performed on separate SHOULD be referred to as the "source branch". Each change branch also
branches that SHOULD be referred to as "change branches". All change needs a designated "merge target" branch, typically this will be the same
branches MUST have descriptive names. It is RECOMMENDED that you commit as the source branch.</li>
often locally, and you SHOULD regularly push your work to the same named <li>Change branches MUST be regularly updated with any changes from their
branch on the remote server.</li> source branch. This MUST be done by rebasing the change branch on top of
<li>You MUST create separate change branches for each distinctly different the source branch.</li>
change. You MUST NOT include multiple unrelated changes into a single <li>After rebasing a change branch on top of its source branch you MUST push
change branch.</li> the change branch to the remote server. This will require you to do a
<li>When a change branch is created, the branch that it is created from force push, and you SHOULD use the "--force-with-lease" git push option.</li>
SHOULD be referred to as the "source branch". Each change branch also </ol>
needs a designated "merge target" branch, typically this will be the same </li>
as the source branch.</li> <li>Pull Requests
<li>Change branches MUST be regularly updated with any changes from their <ol>
source branch. This MUST be done by rebasing the change branch on top of <li>To merge a change branch into its merge target, you MUST open a "pull
the source branch.</li> request" (or equivalent) so others can review and approve your changes.</li>
<li>After rebasing a change branch on top of its source branch you MUST push <li>A pull request MUST only be merged when the change branch is up-to-date
the change branch to the remote server. This will require you to do a with its source branch, the test suite is passing, and you and others are
force push, and you SHOULD use the "--force-with-lease" git push option.</li> happy with the change. This is especially important if the merge target
</ol> is the master branch.</li>
</li> <li>To get feedback, help, or generally just discuss a change branch with
<li>Pull Requests others, the RECOMMENDED way to do so is by creating a pull request and
<ol> discuss the changes with others there.</li>
<li>To merge a change branch into its merge target, you MUST open a "pull </ol>
request" (or equivalent) so others can review and approve your changes.</li> </li>
<li>A pull request MUST only be merged when the change branch is up-to-date <li>Versioning
with its source branch, the test suite is passing, and you and others are <ol>
happy with the change. This is especially important if the merge target <li>The project MUST have its version hard-coded somewhere in the
is the master branch.</li> code-base. It is RECOMMENDED that this is done in a file called "VERSION"
<li>To get feedback, help, or generally just discuss a change branch with located in the root of the project.</li>
others, the RECOMMENDED way to do so is by creating a pull request and <li>If you are using a "VERSION" file in the root of the project, this MUST
discuss the changes with others there.</li> only contain the exact version string.</li>
</ol> <li>The version string SHOULD follow the Semantic Versioning
</li> (<a href="http://semver.org/">http://semver.org/</a>) format. Use of Semantic Versioning is OPTIONAL,
<li>Versioning but the version string MUST NOT have a "v" prefix. For example "v2.11.4"
<ol> is bad, and "2.11.4" is good.</li>
<li>The project MUST have its version hard-coded somewhere in the </ol>
code-base. It is RECOMMENDED that this is done in a file called "VERSION" </li>
located in the root of the project.</li> <li>Releases
<li>If you are using a "VERSION" file in the root of the project, this MUST <ol>
only contain the exact version string.</li> <li>To create a new release, you MUST create a "version bump" commit which
<li>The version string SHOULD follow the Semantic Versioning changes the hard-coded version string of the project. The version bump
(<a href="http://semver.org/">http://semver.org/</a>) format. Use of Semantic Versioning is OPTIONAL, commit MUST have a git tag created on it and named as the exact version
but the version string MUST NOT have a "v" prefix. For example "v2.11.4" string.</li>
is bad, and "2.11.4" is good.</li> <li>If you are not using a release branch, then the version bump commit MUST
</ol> be created directly on the master branch.</li>
</li> <li>The version bump commit MUST have a commit message title of "Bump version
<li>Releases to VERSION". For example, if the new version string is "2.11.4", the
<ol> first line of the commit message MUST read: "Bump version to 2.11.4"</li>
<li>To create a new release, you MUST create a "version bump" commit which <li>The release tag on the version bump commit MUST be named exactly the same
changes the hard-coded version string of the project. The version bump as the version string. The tag name can OPTIONALLY be prefixed with
commit MUST have a git tag created on it and named as the exact version "v". For example the tag name can be either "2.11.4" or "v2.11.4". You
string.</li> MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form
<li>If you are not using a release branch, then the version bump commit MUST and stick to it.</li>
be created directly on the master branch.</li> <li>It is RECOMMENDED that release tags are lightweight tags, but you can
<li>The version bump commit MUST have a commit message title of "Bump version OPTIONALLY use annotated tags if you want to include changelog
to VERSION". For example, if the new version string is "2.11.4", the information in the release tag itself.</li>
first line of the commit message MUST read: "Bump version to 2.11.4"</li> <li>If you use annotated release tags, the first line of the annotation MUST
<li>The release tag on the version bump commit MUST be named exactly the same read "Release VERSION". For example for version "2.11.4" the first line
as the version string. The tag name can OPTIONALLY be prefixed with of the tag annotation would read "Release 2.11.4". The second line must
"v". For example the tag name can be either "2.11.4" or "v2.11.4". You be blank, and the changelog MUST start on the third line.</li>
MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form </ol>
and stick to it.</li> </li>
<li>It is RECOMMENDED that release tags are lightweight tags, but you can <li>Release Branches
OPTIONALLY use annotated tags if you want to include changelog <ol>
information in the release tag itself.</li> <li>Any branch that has a name starting with "release-" SHOULD be referred to
<li>If you use annotated release tags, the first line of the annotation MUST as a "release branch".</li>
read "Release VERSION". For example for version "2.11.4" the first line <li>Use of release branches is OPTIONAL.</li>
of the tag annotation would read "Release 2.11.4". The second line must <li>Changes in a release branch SHOULD typically come from work being
be blank, and the changelog MUST start on the third line.</li> done against the master branch. Meaning changes SHOULD only trickle
</ol> downwards from the master branch. If a change needs to trickle back up
</li> into the master branch, that work should have happened against the master
<li>Release Branches branch in the first place. One exception to this is version bump commits.</li>
<ol> <li>There are two types of release branches; short-term, and long-term.</li>
<li>Any branch that has a name starting with "release-" SHOULD be referred to <li>Short-Term Release Branches
as a "release branch".</li> <ol>
<li>Use of release branches is OPTIONAL.</li> <li>Used for creating a specific versioned release.</li>
<li>Changes in a release branch SHOULD typically come from work being <li>A short-term release branch is RECOMMENDED if there is a lengthy
done against the master branch. Meaning changes SHOULD only trickle pre-release verification process to avoid a code freeze on the master
downwards from the master branch. If a change needs to trickle back up branch.</li>
into the master branch, that work should have happened against the master <li>MUST have a name of "release-VERSION". For example for version
branch in the first place. One exception to this is version bump commits.</li> "2.11.4" the release branch name MUST be "release-2.11.4".</li>
<li>There are two types of release branches; short-term, and long-term.</li> <li>When using a short-term release branch, the version bump commit and
<li>Short-Term Release Branches release tag MUST be made directly on the release branch itself.</li>
<ol> <li>Only very minor changes should be performed on a short-term release
<li>Used for creating a specific versioned release.</li> branch directly. Any larger changes SHOULD be done in the master
<li>A short-term release branch is RECOMMENDED if there is a lengthy branch, and SHOULD be pulled into the release branch by rebasing it
pre-release verification process to avoid a code freeze on the master on top of the master branch the same way a change branch pulls in
branch.</li> updates from its source branch.</li>
<li>MUST have a name of "release-VERSION". For example for version <li>After the version bump commit and release tag have been created, the
"2.11.4" the release branch name MUST be "release-2.11.4".</li> release branch MUST be merged back into its source branch and then
<li>When using a short-term release branch, the version bump commit and deleted. Typically the source branch will be the master branch.</li>
release tag MUST be made directly on the 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 <li>Long-Term Release Branches
branch, and SHOULD be pulled into the release branch by rebasing it <ol>
on top of the master branch the same way a change branch pulls in <li>Used for work on versions which are not currently part of the master
updates from its source branch.</li> branch. Typically this is useful when you need to create a new
<li>After the version bump commit and release tag have been created, the maintenance release for a older version.</li>
release branch MUST be merged back into its source branch and then <li>The branch name MUST have a non-specific version number. For example
deleted. Typically the source branch will be the master branch.</li> a long-term release branch for creating new 2.9.x releases would be
</ol> named "release-2.9".</li>
</li> <li>To create a new release from a long-term release branch, you MUST
<li>Long-Term Release Branches create a version bump commit and release tag directly on the release
<ol> branch.</li>
<li>Used for work on versions which are not currently part of the master <li>A long-term release branch MUST be created from the relevant release
branch. Typically this is useful when you need to create a new tag. For example if the master branch is on version 2.11.4 and there
maintenance release for a older version.</li> is a security fix for all 2.9.x releases, the latest of which is
<li>The branch name MUST have a non-specific version number. For example "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7"
a long-term release branch for creating new 2.9.x releases would be release tag. The security fix release will then end up being version
named "release-2.9".</li> "2.9.8".</li>
<li>To create a new release from a long-term release branch, you MUST </ol>
create a version bump commit and release tag directly on the release </li>
branch.</li> </ol>
<li>A long-term release branch MUST be created from the relevant release </li>
tag. For example if the master branch is on version 2.11.4 and there <li>Bug Fixes &amp; Rollback
is a security fix for all 2.9.x releases, the latest of which is <ol>
"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" <li>You MUST NOT under any circumstances force push to the master branch.</li>
release tag. The security fix release will then end up being version <li>If a change branch which has been merged into the master branch is found
"2.9.8".</li> to have a bug in it, the bug fix work MUST be done as a new separate
</ol> change branch and MUST follow the same workflow as any other change
</li> branch.</li>
</ol> <li>If a change branch is wrongfully merged into master, or for any other
</li> reason the merge must be undone, you MUST undo the merge by reverting the
<li>Bug Fixes &amp; Rollback merge commit itself. Effectively creating a new commit that reverses all
<ol> the relevant changes.</li>
<li>You MUST NOT under any circumstances force push to the master branch.</li> </ol>
<li>If a change branch which has been merged into the master branch is found </li>
to have a bug in it, the bug fix work MUST be done as a new separate <li>Git Best Practices
change branch and MUST follow the same workflow as any other change <ol>
branch.</li> <li>All commit messages SHOULD follow the Commit Guidelines and format from
<li>If a change branch is wrongfully merged into master, or for any other the official git
reason the merge must be undone, you MUST undo the merge by reverting the documentation:
merge commit itself. Effectively creating a new commit that reverses all <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>
the relevant changes.</li> <li>You SHOULD never blindly commit all changes with "git commit -a". It is
</ol> RECOMMENDED you use "git add -i" to add individual changes to the staging
</li> area so you are fully aware of what you are committing.</li>
<li>Git Best Practices <li>You SHOULD always use "--force-with-lease" when doing a force push. The
<ol> regular "--force" option is dangerous and destructive. More
<li>All commit messages SHOULD follow the Commit Guidelines and format from information:
the official git <a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
documentation: <li>You SHOULD understand and be comfortable with
<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> 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>You SHOULD never blindly commit all changes with "git commit -a". It is <li>It is RECOMMENDED that you always do "git pull --rebase" instead of "git
RECOMMENDED you use "git add -i" to add individual changes to the staging pull" to avoid unnecessary merge commits. You can make this the default
area so you are fully aware of what you are committing.</li> behavior of "git pull" with "git config --global pull.rebase true".</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The <li>It is RECOMMENDED that all branches be merged using "git merge --no-ff".
regular "--force" option is dangerous and destructive. More This makes sure the reference to the original branch is kept in the
information: commits, allows one to revert a merge by reverting a single merge commit,
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li> and creates a merge commit to mark the integration of the branch with
<li>You SHOULD understand and be comfortable with master.</li>
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> </ol>
<li>It is RECOMMENDED that you always do "git pull --rebase" instead of "git </li>
pull" to avoid unnecessary merge commits. You can make this the default </ol>
behavior of "git pull" with "git config --global pull.rebase true".</li> <h2 id="about">About</h2>
<li>It is RECOMMENDED that all branches be merged using "git merge --no-ff". <p>The Git Common-Flow specification is authored
This makes sure the reference to the original branch is kept in the by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
commits, allows one to revert a merge by reverting a single merge commit, <p>If you'd like to leave feedback,
and creates a merge commit to mark the integration of the branch with please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
master.</li> <h2 id="license">License</h2>
</ol> <p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</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> </div>
</div> </div>
<script src="/js/ui.js"></script> <script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
<script>
if (window.location.hostname == "commonflow.org") {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102330905-1', 'auto');
ga('send', 'pageview');
} else { _gaq = []; };
</script>
</body> </body>
</html> </html>

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

@@ -0,0 +1,292 @@
<!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 type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.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.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>
<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>
<script>
if (window.location.hostname == "commonflow.org") {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102330905-1', 'auto');
ga('send', 'pageview');
} else { _gaq = []; };
</script>
</body>
</html>

2
docs/spec/1.0.0-rc.3.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -1,11 +1,11 @@
--- ---
title: Git Common-Flow 1.0.0-rc.2 title: Git Common-Flow 1.0.0-rc.3
version: 1.0.0-rc.2 version: 1.0.0-rc.3
--- ---
Git Common-Flow 1.0.0-rc.2 Git Common-Flow 1.0.0-rc.3
============================== ===========================
<img src="/spec/1.0.0-rc.2.svg" width="100%" /> <img src="/spec/1.0.0-rc.3.svg" width="100%" />
Summary Summary
------- -------
@@ -16,15 +16,15 @@ the [original variant](http://scottchacon.com/2011/08/31/github-flow.html)
of [GitHub Flow](https://guides.github.com/introduction/flow/), while taking of [GitHub Flow](https://guides.github.com/introduction/flow/), while taking
into account how a lot of open source projects use git. into account how a lot of open source projects use git.
TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned In short, Common-Flow is essentially GitHub Flow with the addition of versioned
releases, maintenance releases for old versions, and without the requirement to releases, optional release branches, and without the requirement to deploy to
deploy to production all the time. production all the time.
Terminology Terminology
----------- -----------
- **Master Branch** - Must always have passing tests, is considered bleeding - **Master Branch** - Must be named "master", must always have passing tests,
edge, and must be named `master`. and is not guaranteed to always work in production environments.
- **Change Branches** - Any branch that introduces changes like a new feature, a - **Change Branches** - Any branch that introduces changes like a new feature, a
bug fix, etc. bug fix, etc.
- **Source Branch** - The branch that a change branch was created from. New - **Source Branch** - The branch that a change branch was created from. New
@@ -35,7 +35,8 @@ Terminology
branch. branch.
- **Pull Request** - A means of requesting that a change branch is merged in to - **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. its merge target, allowing others to review, discuss and approve the changes.
- **Release** - Consists of a version bump commit, and a git tag named according - **Release** - 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. to the new version string placed on said commit.
- **Release Branches** - Used both for short-term preparations of a release, and - **Release Branches** - Used both for short-term preparations of a release, and
also for long-term maintenance of older version. also for long-term maintenance of older version.
@@ -47,16 +48,21 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
1. The Master Branch 1. TL;DR
1. Don't 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 1. A branch named "master" MUST exist and it MUST be referred to as the
"master branch". "master branch".
2. The master branch MUST be considered bleeding edge. 2. The master branch MUST always be in a non-broken state with its test
3. The master branch MUST always be in a non-broken state with its test
suite passing. suite passing.
4. The master branch SHOULD always be in a "as near as possibly ready for 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/production" state to reduce any friction with creating a new
release. release.
2. Change Branches 3. Change Branches
1. Each change (feature, bugfix, etc.) MUST be performed on separate 1. Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as "change branches". All change branches that SHOULD be referred to as "change branches". All change
branches MUST have descriptive names. It is RECOMMENDED that you commit branches MUST have descriptive names. It is RECOMMENDED that you commit
@@ -75,7 +81,7 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
5. After rebasing a change branch on top of its source branch you MUST push 5. 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 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. force push, and you SHOULD use the "--force-with-lease" git push option.
3. Pull Requests 4. Pull Requests
1. To merge a change branch into its merge target, you MUST open a "pull 1. To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent) so others can review and approve your changes. request" (or equivalent) so others can review and approve your changes.
2. A pull request MUST only be merged when the change branch is up-to-date 2. A pull request MUST only be merged when the change branch is up-to-date
@@ -85,7 +91,7 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
3. To get feedback, help, or generally just discuss a change branch with 3. 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 others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there. discuss the changes with others there.
4. Versioning 5. Versioning
1. The project MUST have its version hard-coded somewhere in the 1. The project MUST have its version hard-coded somewhere in the
code-base. It is RECOMMENDED that this is done in a file called "VERSION" code-base. It is RECOMMENDED that this is done in a file called "VERSION"
located in the root of the project. located in the root of the project.
@@ -95,7 +101,7 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
(<http://semver.org/>) format. Use of Semantic Versioning is OPTIONAL, (<http://semver.org/>) format. Use of Semantic Versioning is OPTIONAL,
but the version string MUST NOT have a "v" prefix. For example "v2.11.4" but the version string MUST NOT have a "v" prefix. For example "v2.11.4"
is bad, and "2.11.4" is good. is bad, and "2.11.4" is good.
5. Releases 6. Releases
1. To create a new release, you MUST create a "version bump" commit which 1. 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 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 commit MUST have a git tag created on it and named as the exact version
@@ -117,7 +123,7 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
read "Release VERSION". For example for version "2.11.4" the first line 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 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. be blank, and the changelog MUST start on the third line.
6. Release Branches 7. Release Branches
1. Any branch that has a name starting with "release-" SHOULD be referred to 1. Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch". as a "release branch".
2. Use of release branches is OPTIONAL. 2. Use of release branches is OPTIONAL.
@@ -160,7 +166,7 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7"
release tag. The security fix release will then end up being version release tag. The security fix release will then end up being version
"2.9.8". "2.9.8".
7. Bug Fixes & Rollback 8. Bug Fixes & Rollback
1. You MUST NOT under any circumstances force push to the master branch. 1. You MUST NOT under any circumstances force push to the master branch.
2. If a change branch which has been merged into the master branch is found 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 to have a bug in it, the bug fix work MUST be done as a new separate
@@ -170,11 +176,11 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
reason the merge must be undone, you MUST undo the merge by reverting the 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 merge commit itself. Effectively creating a new commit that reverses all
the relevant changes. the relevant changes.
8. Git Best Practices 9. Git Best Practices
1. All commit messages SHOULD follow the Commit Guidelines and format from 1. All commit messages SHOULD follow the Commit Guidelines and format from
the official git the official git
documentation: documentation:
<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#_commit_guidelines>
2. You SHOULD never blindly commit all changes with "git commit -a". It is 2. 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 RECOMMENDED you use "git add -i" to add individual changes to the staging
area so you are fully aware of what you are committing. area so you are fully aware of what you are committing.

View File

@@ -1,46 +0,0 @@
(function (window, document) {
var layout = document.getElementById('layout'),
menu = document.getElementById('menu'),
menuLink = document.getElementById('menuLink'),
content = document.getElementById('main');
function toggleClass(element, className) {
var classes = element.className.split(/\s+/),
length = classes.length,
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));

215
spec/1.0.0-rc.3.md Normal file
View File

@@ -0,0 +1,215 @@
---
title: Git Common-Flow 1.0.0-rc.3
version: 1.0.0-rc.3
---
Git Common-Flow 1.0.0-rc.3
===========================
<img src="/spec/1.0.0-rc.3.svg" width="100%" />
Summary
-------
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 use git.
In short, Common-Flow is essentially GitHub Flow with the addition of versioned
releases, optional release branches, and without the requirement to deploy to
production all the time.
Terminology
-----------
- **Master Branch** - Must be named "master", must always have passing tests,
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. Consists of a version bump commit, and a git tag named according
to the new version string placed on said commit.
- **Release Branches** - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.
Git Common-Flow Specification (Common-Flow)
-------------------------------------------
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
1. TL;DR
1. Don't 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". All change
branches MUST have descriptive names. It is RECOMMENDED that you commit
often locally, and you SHOULD regularly push your work to the same named
branch on the remote server.
2. You MUST create separate change branches for each distinctly different
change. You MUST NOT include multiple unrelated changes into a single
change branch.
3. 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.
4. 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.
5. 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.
4. Pull Requests
1. To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent) so others can review and approve your changes.
2. 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.
3. 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.
5. Versioning
1. The project MUST have its version hard-coded somewhere in the
code-base. It is RECOMMENDED that this is done in a file called "VERSION"
located in the root of the project.
2. If you are using a "VERSION" file in the root of the project, this MUST
only contain the exact version string.
3. The version string SHOULD follow the Semantic Versioning
(<http://semver.org/>) format. Use of Semantic Versioning is OPTIONAL,
but the version string MUST NOT have a "v" prefix. For example "v2.11.4"
is bad, and "2.11.4" is good.
6. Releases
1. 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.
2. If you are not using a release branch, then the version bump commit MUST
be created directly on the master branch.
3. 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"
4. 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.
5. 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.
6. 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.
7. Release Branches
1. Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".
2. Use of release branches is OPTIONAL.
3. 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.
4. There are two types of release branches; short-term, and long-term.
5. Short-Term Release Branches
1. Used for creating a specific versioned release.
2. 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.
3. MUST have a name of "release-VERSION". For example for version
"2.11.4" the release branch name MUST be "release-2.11.4".
4. When using a short-term release branch, the version bump commit and
release tag MUST be made directly on the release branch itself.
5. 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.
6. 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.
6. Long-Term Release Branches
1. 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.
2. 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".
3. 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.
4. 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".
8. Bug Fixes & Rollback
1. You MUST NOT under any circumstances force push to the master branch.
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.
9. 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" 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.
About
-----
The Git Common-Flow specification is authored
by [Jim Myhrberg](http://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 3.0](http://creativecommons.org/licenses/by/3.0/)

2
spec/1.0.0-rc.3.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 18 KiB