5 Commits

Author SHA1 Message Date
42deba342a Update to version 1.0.0-rc.4 2017-08-29 02:17:29 +01:00
95f217fa2e Rebuild site with new github link in sidebar 2017-08-08 22:53:42 +01:00
8028308194 Add link to Github repo in sidebar 2017-08-08 22:50:44 +01:00
28f128b355 Use nested scss syntax 2017-08-08 22:50:17 +01:00
42fd1b4358 Rmove use of Google Analytics
Keeps the site as "clean" as possible, also GA isn't very useful
thanks to ad-blockers :)
2017-07-17 23:28:32 +01:00
16 changed files with 1277 additions and 273 deletions

View File

@@ -32,23 +32,46 @@ ul ul ol, ul ol ol, ol ul ol, ol ol ol {
.content { .content {
margin-top: 80px; margin-top: 80px;
a {
word-break: break-word;
}
code {
background-color: rgba(27,31,35,0.05);
border-radius: 3px;
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 90%;
margin: 0;
padding: 0.2em;
}
} }
.content a {
word-break: break-word;
}
.content code { #menu {
background-color: rgba(27,31,35,0.05); .pure-menu-label {
border-radius: 3px; color: #999;
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace; border: none;
font-size: 90%; padding: 0.6em 0 0.6em 0.6em;
margin: 0; }
padding: 0.2em;
}
#menu .pure-menu-label { .links {
color: #999; font-size: 50px;
border: none; position: absolute;
padding: 0.6em 0 0.6em 0.6em; bottom: 10px;
left: 0px;
right: 0px;
text-align: center;
a {
color: #555;
padding: 0;
position: relative;
text-decoration: none;
&:hover {
color: #777;
}
}
}
} }

View File

@@ -6,8 +6,9 @@ author: Jim Myhrberg
hostname: commonflow.org hostname: commonflow.org
url: https://commonflow.org url: https://commonflow.org
current_version: 1.0.0-rc.3 current_version: 1.0.0-rc.4
versions: versions:
- 1.0.0-rc.4
- 1.0.0-rc.3 - 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

View File

@@ -1,10 +0,0 @@
<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,6 +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="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
{% css main %} {% css main %}
{% seo %} {% seo %}
</head> </head>
@@ -35,6 +36,11 @@
{% endfor %} {% endfor %}
</ul> </ul>
</div> </div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div> </div>
<div id="main"> <div id="main">
@@ -44,6 +50,5 @@
</div> </div>
</div> </div>
{% js main %} {% js main %}
{% include analytics.html %}
</body> </body>
</html> </html>

View File

@@ -6,7 +6,8 @@
<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 type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css"> <link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.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" />
@@ -33,6 +34,9 @@
<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.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3"> <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> <a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li> </li>
@@ -44,6 +48,11 @@
</li> </li>
</ul> </ul>
</div> </div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
@@ -56,15 +65,5 @@
</div> </div>
</div> </div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.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}#menu .links{font-size:50px;position:absolute;bottom:10px;left:0px;right:0px;text-align:center}#menu .links a{color:#555;padding:0;position:relative;text-decoration:none}#menu .links a:hover{color:#777}

View File

@@ -6,10 +6,11 @@
<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 type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css"> <link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.css">
<!-- Begin Jekyll SEO tag v2.2.3 --> <!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.3 | Git Common Flow</title> <title>Git Common-Flow 1.0.0-rc.4 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.3" /> <meta property="og:title" content="Git Common-Flow 1.0.0-rc.4" />
<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." />
@@ -18,7 +19,7 @@
<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.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/"} {"@context":"http://schema.org","@type":"WebSite","name":"Git Common Flow","headline":"Git Common-Flow 1.0.0-rc.4","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/"}
</script> </script>
<!-- End Jekyll SEO tag --> <!-- End Jekyll SEO tag -->
</head> </head>
@@ -33,7 +34,10 @@
<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"> <li class="pure-menu-item version-1.0.0-rc.4 pure-menu-selected">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a> <a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li> </li>
<li class="pure-menu-item version-1.0.0-rc.2"> <li class="pure-menu-item version-1.0.0-rc.2">
@@ -44,11 +48,16 @@
</li> </li>
</ul> </ul>
</div> </div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
<h1 id="git-common-flow-100-rc3">Git Common-Flow 1.0.0-rc.3</h1> <h1 id="git-common-flow-100-rc4">Git Common-Flow 1.0.0-rc.4</h1>
<p><img src="/spec/1.0.0-rc.3.svg" width="100%" /></p> <p><img src="/spec/1.0.0-rc.4.svg" width="100%" /></p>
<h2 id="summary">Summary</h2> <h2 id="summary">Summary</h2>
<p>Common-Flow is an attempt to gather a sensible selection of the most common <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 usage patterns of git into a single and concise specification. It is based on
@@ -72,9 +81,8 @@
branch.</li> branch.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to <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> 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 <li><strong>Release</strong> - May be considered safe to use in production environments. Is
environments. Consists of a version bump commit, and a git tag named according effectively just a git tag named after the version of the release.</li>
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 <li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li> also for long-term maintenance of older version.</li>
</ul> </ul>
@@ -106,12 +114,15 @@
<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".</li>
branches MUST have descriptive names. It is RECOMMENDED that you commit <li>All change branches MUST have descriptive names.</li>
often locally, and you SHOULD regularly push your work to the same named <li>It is RECOMMENDED that you commit often locally, and that you try and
branch on the remote server.</li> keep the commits reasonably structured to avoid a messy and confusing git
<li>You MUST create separate change branches for each distinctly different history.</li>
change. You MUST NOT include multiple unrelated changes into a single <li>You SHOULD regularly push your work to the same named branch on the
remote server.</li>
<li>You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.</li> 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
@@ -120,15 +131,32 @@
<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 updating a change branch from its source branch you MUST push the
the change branch to the remote server. This will require you to do a change branch to the remote server. Due to the nature of rebasing, you
force push, and you SHOULD use the "--force-with-lease" git push option.</li> will be required to do a force push, and you MUST use the
"--force-with-lease" git push option when doing so instead of the regular
"--force".</li>
<li>If there is a truly valid technical reason to not use rebase when
updating change branches, then you can update change branches via merge
instead of rebase. The decision to use merge MUST only be taken after all
possible options to use rebase have been tried and failed. People not
understanding how to use rebase is NOT a valid reason to use merge. If
you do decide to use merge instead of rebase, you MUST NOT use a mixture
of both methods, pick one and stick to it.</li>
</ol> </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).</li>
<li>The purpose of a pull request is to allow others to review your changes
and give feedback. You can then fix any issues, complaints, and more that
might arise, and then let people review again.</li>
<li>Before creating a pull request, it is RECOMMENDED that you consider the
state of your change branch's commit history. If it is messy and
confusing, it might be a good idea to rebase your branch with "git rebase
-i" to present a cleaner and easier to follow commit history for your
reviewers.</li>
<li>A pull request MUST only be merged when the change branch is up-to-date <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
@@ -140,97 +168,116 @@
</li> </li>
<li>Versioning <li>Versioning
<ol> <ol>
<li>The project MUST have its version hard-coded somewhere in the <li>A "version string" is a typically mostly numeric string that identifies a
code-base. It is RECOMMENDED that this is done in a file called "VERSION" specific version of a project. The version string itself MUST NOT have a
located in the root of the project.</li> "v" prefix, but the version string can be displayed with a "v" prefix to
<li>If you are using a "VERSION" file in the root of the project, this MUST indicate it is a version that is being referred to.</li>
only contain the exact version string.</li> <li>The source of truth for a project's version MUST be a git tag with a name
<li>The version string SHOULD follow the Semantic Versioning based on the version string. This kind of tag MUST be referred to as a
(<a href="http://semver.org/">http://semver.org/</a>) format. Use of Semantic Versioning is OPTIONAL, "release tag".</li>
but the version string MUST NOT have a "v" prefix. For example "v2.11.4" <li>It is OPTIONAL, but RECOMMENDED to also keep the version string
is bad, and "2.11.4" is good.</li> hard-coded somewhere in the project code-base.</li>
<li>If you hard-code the version string into the code-base, it is RECOMMENDED
that you do so in a file called "VERSION" located in the root of the
project. But be mindful of the conventions of your programming language
and community when choosing if, where and how to hard-code the version
string.</li>
<li>If you are using a "VERSION" file in the root of the project, this file
MUST only contain the exact version string, meaning it MUST NOT have a
"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.</li>
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
</ol> </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 git tag named as the exact
changes the hard-coded version string of the project. The version bump version string of the release. This kind of tag MUST be referred to as a
commit MUST have a git tag created on it and named as the exact version "release tag".</li>
string.</li> <li>The release tag name can OPTIONALLY be prefixed with "v". For example the
<li>If you are not using a release branch, then the version bump commit MUST tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED
be created directly on the master branch.</li> that you do not use a "v" prefix. You MUST NOT use a mixture of "v"
<li>The version bump commit MUST have a commit message title of "Bump version prefixed and non-prefixed tags. Pick one form and stick to it.</li>
to VERSION". For example, if the new version string is "2.11.4", the <li>If the version string is hard-coded into the code-base, you MUST create a
first line of the commit message MUST read: "Bump version to 2.11.4"</li> "version bump" commit which changes the hard-coded version string of the
<li>The release tag on the version bump commit MUST be named exactly the same project.</li>
as the version string. The tag name can OPTIONALLY be prefixed with <li>When using version bump commits, the release tag MUST be placed on the
"v". For example the tag name can be either "2.11.4" or "v2.11.4". You version bump commit.</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 release tag, and if
and stick to it.</li> relevant the version bump commit, MUST be created directly on the master
branch.</li>
<li>The version bump commit SHOULD have a commit message title of "Bump
version to VERSION". For example, if the new version string is "2.11.4",
the first line of the commit message SHOULD read: "Bump version to
2.11.4"</li>
<li>It is RECOMMENDED that release tags are lightweight tags, but you can <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
read "Release VERSION". For example for version "2.11.4" the first line SHOULD read "Release VERSION". For example for version "2.11.4" the first
of the tag annotation would read "Release 2.11.4". The second line must line of the tag annotation SHOULD read "Release 2.11.4". The second line
be blank, and the changelog MUST start on the third line.</li> MUST be blank, and the changelog MUST start on the third line.</li>
</ol> </ol>
</li> </li>
<li>Release Branches <li>Short-Term 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>Any release branch which has a name ending with a specific version
<li>Changes in a release branch SHOULD typically come from work being string, MUST be referred to as a "short-term release branch".</li>
done against the master branch. Meaning changes SHOULD only trickle <li>Use of short-term release branches are OPTIONAL, and intended to be used
downwards from the master branch. If a change needs to trickle back up to create a specific versioned release.</li>
into the master branch, that work should have happened against the master <li>A short-term release branch is RECOMMENDED if there is a lengthy
branch in the first place. One exception to this is version bump commits.</li> pre-release verification process to avoid a code freeze on the master
<li>There are two types of release branches; short-term, and long-term.</li> branch.</li>
<li>Short-Term Release Branches <li>Short-term release branches MUST have a name of "release-VERSION". For
<ol> example for version "2.11.4" the release branch name MUST be
<li>Used for creating a specific versioned release.</li> "release-2.11.4".</li>
<li>A short-term release branch is RECOMMENDED if there is a lengthy <li>When using a short-term release branch to create a release, the release
pre-release verification process to avoid a code freeze on the master tag and if used, version bump commit, MUST be placed directly on the
branch.</li> short-term release branch itself.</li>
<li>MUST have a name of "release-VERSION". For example for version <li>Only very minor changes should be performed on a short-term release
"2.11.4" the release branch name MUST be "release-2.11.4".</li> branch directly. Any larger changes SHOULD be done in the master branch,
<li>When using a short-term release branch, the version bump commit and and SHOULD be pulled into the release branch by rebasing it on top of the
release tag MUST be made directly on the release branch itself.</li> master branch the same way a change branch pulls in updates from its
<li>Only very minor changes should be performed on a short-term release source branch.</li>
branch directly. Any larger changes SHOULD be done in the master <li>After a release tag has been created, the release branch MUST be merged
branch, and SHOULD be pulled into the release branch by rebasing it back into its source branch and then deleted. Typically the source branch
on top of the master branch the same way a change branch pulls in will be the master branch.</li>
updates from its source branch.</li> </ol>
<li>After the version bump commit and release tag have been created, the </li>
release branch MUST be merged back into its source branch and then <li>Long-term Release Branches
deleted. Typically the source branch will be the master branch.</li> <ol>
</ol> <li>Any release branch which has a name ending with a non-specific version
</li> string, MUST be referred to as a "long-term release branch". For example
<li>Long-Term Release Branches "release-2.11" is a long-term release branch, while "release-2.11.4" is a
<ol> short-term release branch.</li>
<li>Used for work on versions which are not currently part of the master <li>Use of long-term release branches are OPTIONAL, and intended for work on
branch. Typically this is useful when you need to create a new versions which are not currently part of the master branch. Typically
maintenance release for a older version.</li> this is useful when you need to create a new maintenance release for a
<li>The branch name MUST have a non-specific version number. For example older version.</li>
a long-term release branch for creating new 2.9.x releases would be <li>A long-term release branch MUST have a name with a non-specific version
named "release-2.9".</li> number. For example a long-term release branch for creating new 2.9.x
<li>To create a new release from a long-term release branch, you MUST releases MUST be named "release-2.9".</li>
create a version bump commit and release tag directly on the release <li>Long-term release branches for maintenance releases of older versions
branch.</li> MUST be created from the relevant release tag. For example if the master
<li>A long-term release branch MUST be created from the relevant release branch is on version 2.11.4 and there is a security fix for all 2.9.x
tag. For example if the master branch is on version 2.11.4 and there releases, the latest of which is "2.9.7". Create a new branch called
is a security fix for all 2.9.x releases, the latest of which is "release-2.9" off of the "2.9.7" release tag. The security fix release
"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" will then end up being version "2.9.8".</li>
release tag. The security fix release will then end up being version <li>To create a new release from a long-term release branch, you MUST follow
"2.9.8".</li> the same process as a release from the master branch, except the
</ol> long-term release branch takes the place of the master branch.</li>
</li> <li>A long-term release branch should be treated with the same respect as the
master branch. It is effectively the master branch for the release series
in question. Meaning it MUST always be in a non-broken state, MUST NOT be
force pushed to, etc.</li>
</ol> </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 or
to long-term release branches.</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
@@ -248,8 +295,9 @@
documentation: 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> <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" or "git add -p" to add individual
area so you are fully aware of what you are committing.</li> 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 <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:
@@ -267,6 +315,79 @@
</ol> </ol>
</li> </li>
</ol> </ol>
<h2 id="faq">FAQ</h2>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<p>Common-Flow tries to be a lot less complicated than Git Flow by having fewer
types of branches, and simpler rules. Normal day to day development doesn't
really change much:</p>
<ul>
<li>You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.</li>
<li>Change branches are typically created off of and merged back into "master"
instead of "develop".</li>
<li>Creating a release is done by simply creating a git tag, typically on the
master branch.</li>
</ul>
<p>In detail, the main differences between Git Flow and Common-Flow are:</p>
<ul>
<li>There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.</li>
<li>There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.</li>
<li>Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.</li>
</ul>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
<p>Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.</p>
<p>If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does "descriptive name" mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it's process.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
that's preventing a new release from master. But if that proves to be a
complicated task and you're short on time, a short-term release branch gives you
a instant fix to the situation at hand, and let's you resolve the issues with
the master branch when you have more time on your hands.</p>
<h2 id="about">About</h2> <h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored <p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p> by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
@@ -278,15 +399,5 @@
</div> </div>
</div> </div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.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

@@ -9,6 +9,9 @@
<url> <url>
<loc>https://commonflow.org/spec/1.0.0-rc.3.html</loc> <loc>https://commonflow.org/spec/1.0.0-rc.3.html</loc>
</url> </url>
<url>
<loc>https://commonflow.org/spec/1.0.0-rc.4.html</loc>
</url>
<url> <url>
<loc>https://commonflow.org/</loc> <loc>https://commonflow.org/</loc>
</url> </url>

View File

@@ -6,7 +6,8 @@
<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 type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css"> <link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.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" />
@@ -33,6 +34,9 @@
<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.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3"> <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> <a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li> </li>
@@ -44,6 +48,11 @@
</li> </li>
</ul> </ul>
</div> </div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
@@ -235,15 +244,5 @@
</div> </div>
</div> </div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.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,7 +6,8 @@
<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 type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css"> <link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.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" />
@@ -33,6 +34,9 @@
<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.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3"> <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> <a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li> </li>
@@ -44,6 +48,11 @@
</li> </li>
</ul> </ul>
</div> </div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
@@ -269,15 +278,5 @@
</div> </div>
</div> </div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.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,7 +6,8 @@
<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 type="text/css" rel="stylesheet" href="/assets/main-082b10f3e2581d4b34b66958419ec52aec823571e474eb04ffdb3b7c4e6f455e.css"> <link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.css">
<!-- Begin Jekyll SEO tag v2.2.3 --> <!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.3 | 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.3" /> <meta property="og:title" content="Git Common-Flow 1.0.0-rc.3" />
@@ -33,6 +34,9 @@
<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.4">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3 pure-menu-selected"> <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> <a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li> </li>
@@ -44,6 +48,11 @@
</li> </li>
</ul> </ul>
</div> </div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div> </div>
<div id="main"> <div id="main">
<div class="content"> <div class="content">
@@ -278,15 +287,5 @@
</div> </div>
</div> </div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.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>

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

@@ -0,0 +1,403 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700,300|Open+Sans:400italic,700italic,400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.0/build/pure-min.css" integrity="sha384-nn4HPE8lTHyVtfCBi5yW9d20FjT8BJwUXyWZT9InLYax14RDjBj46LmSztkmNP9w" crossorigin="anonymous">
<link rel="stylesheet" href="https:////maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link type="text/css" rel="stylesheet" href="/assets/main-16db41e8ef2362fe9967bb0bee92e459cf76f2a846e85c96322243077a88c301.css">
<!-- Begin Jekyll SEO tag v2.2.3 -->
<title>Git Common-Flow 1.0.0-rc.4 | Git Common Flow</title>
<meta property="og:title" content="Git Common-Flow 1.0.0-rc.4" />
<meta name="author" content="Jim Myhrberg" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<meta property="og:description" content="An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification." />
<link rel="canonical" href="https://commonflow.org/spec/1.0.0-rc.4.html" />
<meta property="og:url" content="https://commonflow.org/spec/1.0.0-rc.4.html" />
<meta property="og:site_name" content="Git Common Flow" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebPage","headline":"Git Common-Flow 1.0.0-rc.4","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/spec/1.0.0-rc.4.html"}
</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="layout">
<a href="#menu" id="menuLink" class="menu-link">
<span></span>
</a>
<div id="menu">
<div class="pure-menu">
<ul class="pure-menu-list">
<li class="pure-menu-item">
<div class="pure-menu-label">Versions:</div>
</li>
<li class="pure-menu-item version-1.0.0-rc.4 pure-menu-selected">
<a href="/spec/1.0.0-rc.4.html" class="pure-menu-link">1.0.0-rc.4</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.3">
<a href="/spec/1.0.0-rc.3.html" class="pure-menu-link">1.0.0-rc.3</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.2">
<a href="/spec/1.0.0-rc.2.html" class="pure-menu-link">1.0.0-rc.2</a>
</li>
<li class="pure-menu-item version-1.0.0-rc.1">
<a href="/spec/1.0.0-rc.1.html" class="pure-menu-link">1.0.0-rc.1</a>
</li>
</ul>
</div>
<div class="links">
<a href="https://github.com/jimeh/common-flow">
<i class="fa fa-github" aria-hidden="true"></i>
</a>
</div>
</div>
<div id="main">
<div class="content">
<h1 id="git-common-flow-100-rc4">Git Common-Flow 1.0.0-rc.4</h1>
<p><img src="/spec/1.0.0-rc.4.svg" width="100%" /></p>
<h2 id="summary">Summary</h2>
<p>Common-Flow is an attempt to gather a sensible selection of the most common
usage patterns of git into a single and concise specification. It is based on
the <a href="http://scottchacon.com/2011/08/31/github-flow.html">original variant</a>
of <a href="https://guides.github.com/introduction/flow/">GitHub Flow</a>, while taking
into account how a lot of open source projects use git.</p>
<p>In short, Common-Flow is essentially GitHub Flow with the addition of versioned
releases, optional release branches, and without the requirement to deploy to
production all the time.</p>
<h2 id="terminology">Terminology</h2>
<ul>
<li><strong>Master Branch</strong> - Must be named "master", must always have passing tests,
and is not guaranteed to always work in production environments.</li>
<li><strong>Change Branches</strong> - Any branch that introduces changes like a new feature, a
bug fix, etc.</li>
<li><strong>Source Branch</strong> - The branch that a change branch was created from. New
changes in the source branch should be incorporated into the change branch via
rebasing.</li>
<li><strong>Merge Target</strong> - A branch that is the intended merge target for a change
branch. Typically the merge target branch will be the same as the source
branch.</li>
<li><strong>Pull Request</strong> - A means of requesting that a change branch is merged in to
its merge target, allowing others to review, discuss and approve the changes.</li>
<li><strong>Release</strong> - May be considered safe to use in production environments. Is
effectively just a git tag named after the version of the release.</li>
<li><strong>Release Branches</strong> - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.</li>
</ul>
<h2 id="git-common-flow-specification-common-flow">Git Common-Flow Specification (Common-Flow)</h2>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in <a href="https://tools.ietf.org/html/rfc2119">RFC 2119</a>.</p>
<ol>
<li>TL;DR
<ol>
<li>Don't break the master branch.</li>
<li>A release is a git tag.</li>
</ol>
</li>
<li>The Master Branch
<ol>
<li>A branch named "master" MUST exist and it MUST be referred to as the
"master branch".</li>
<li>The master branch MUST always be in a non-broken state with its test
suite passing.</li>
<li>The master branch IS NOT guaranteed to always work in production
environments. Despite test suites passing it may at times contain
unfinished work. Only releases may be considered safe for production use.</li>
<li>The master branch SHOULD always be in a "as near as possibly ready for
release/production" state to reduce any friction with creating a new
release.</li>
</ol>
</li>
<li>Change Branches
<ol>
<li>Each change (feature, bugfix, etc.) MUST be performed on separate
branches that SHOULD be referred to as "change branches".</li>
<li>All change branches MUST have descriptive names.</li>
<li>It is RECOMMENDED that you commit often locally, and that you try and
keep the commits reasonably structured to avoid a messy and confusing git
history.</li>
<li>You SHOULD regularly push your work to the same named branch on the
remote server.</li>
<li>You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.</li>
<li>When a change branch is created, the branch that it is created from
SHOULD be referred to as the "source branch". Each change branch also
needs a designated "merge target" branch, typically this will be the same
as the source branch.</li>
<li>Change branches MUST be regularly updated with any changes from their
source branch. This MUST be done by rebasing the change branch on top of
the source branch.</li>
<li>After updating a change branch from its source branch you MUST push the
change branch to the remote server. Due to the nature of rebasing, you
will be required to do a force push, and you MUST use the
"--force-with-lease" git push option when doing so instead of the regular
"--force".</li>
<li>If there is a truly valid technical reason to not use rebase when
updating change branches, then you can update change branches via merge
instead of rebase. The decision to use merge MUST only be taken after all
possible options to use rebase have been tried and failed. People not
understanding how to use rebase is NOT a valid reason to use merge. If
you do decide to use merge instead of rebase, you MUST NOT use a mixture
of both methods, pick one and stick to it.</li>
</ol>
</li>
<li>Pull Requests
<ol>
<li>To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent).</li>
<li>The purpose of a pull request is to allow others to review your changes
and give feedback. You can then fix any issues, complaints, and more that
might arise, and then let people review again.</li>
<li>Before creating a pull request, it is RECOMMENDED that you consider the
state of your change branch's commit history. If it is messy and
confusing, it might be a good idea to rebase your branch with "git rebase
-i" to present a cleaner and easier to follow commit history for your
reviewers.</li>
<li>A pull request MUST only be merged when the change branch is up-to-date
with its source branch, the test suite is passing, and you and others are
happy with the change. This is especially important if the merge target
is the master branch.</li>
<li>To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.</li>
</ol>
</li>
<li>Versioning
<ol>
<li>A "version string" is a typically mostly numeric string that identifies a
specific version of a project. The version string itself MUST NOT have a
"v" prefix, but the version string can be displayed with a "v" prefix to
indicate it is a version that is being referred to.</li>
<li>The source of truth for a project's version MUST be a git tag with a name
based on the version string. This kind of tag MUST be referred to as a
"release tag".</li>
<li>It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.</li>
<li>If you hard-code the version string into the code-base, it is RECOMMENDED
that you do so in a file called "VERSION" located in the root of the
project. But be mindful of the conventions of your programming language
and community when choosing if, where and how to hard-code the version
string.</li>
<li>If you are using a "VERSION" file in the root of the project, this file
MUST only contain the exact version string, meaning it MUST NOT have a
"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.</li>
<li>It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<a href="http://semver.org/">http://semver.org/</a>).</li>
</ol>
</li>
<li>Releases
<ol>
<li>To create a new release, you MUST create a git tag named as the exact
version string of the release. This kind of tag MUST be referred to as a
"release tag".</li>
<li>The release tag name can OPTIONALLY be prefixed with "v". For example the
tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED
that you do not use a "v" prefix. You MUST NOT use a mixture of "v"
prefixed and non-prefixed tags. Pick one form and stick to it.</li>
<li>If the version string is hard-coded into the code-base, you MUST create a
"version bump" commit which changes the hard-coded version string of the
project.</li>
<li>When using version bump commits, the release tag MUST be placed on the
version bump commit.</li>
<li>If you are not using a release branch, then the release tag, and if
relevant the version bump commit, MUST be created directly on the master
branch.</li>
<li>The version bump commit SHOULD have a commit message title of "Bump
version to VERSION". For example, if the new version string is "2.11.4",
the first line of the commit message SHOULD read: "Bump version to
2.11.4"</li>
<li>It is RECOMMENDED that release tags are lightweight tags, but you can
OPTIONALLY use annotated tags if you want to include changelog
information in the release tag itself.</li>
<li>If you use annotated release tags, the first line of the annotation
SHOULD read "Release VERSION". For example for version "2.11.4" the first
line of the tag annotation SHOULD read "Release 2.11.4". The second line
MUST be blank, and the changelog MUST start on the third line.</li>
</ol>
</li>
<li>Short-Term Release Branches
<ol>
<li>Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".</li>
<li>Any release branch which has a name ending with a specific version
string, MUST be referred to as a "short-term release branch".</li>
<li>Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.</li>
<li>A short-term release branch is RECOMMENDED if there is a lengthy
pre-release verification process to avoid a code freeze on the master
branch.</li>
<li>Short-term release branches MUST have a name of "release-VERSION". For
example for version "2.11.4" the release branch name MUST be
"release-2.11.4".</li>
<li>When using a short-term release branch to create a release, the release
tag and if used, version bump commit, MUST be placed directly on the
short-term release branch itself.</li>
<li>Only very minor changes should be performed on a short-term release
branch directly. Any larger changes SHOULD be done in the master branch,
and SHOULD be pulled into the release branch by rebasing it on top of the
master branch the same way a change branch pulls in updates from its
source branch.</li>
<li>After a release tag has been created, the release branch MUST be merged
back into its source branch and then deleted. Typically the source branch
will be the master branch.</li>
</ol>
</li>
<li>Long-term Release Branches
<ol>
<li>Any release branch which has a name ending with a non-specific version
string, MUST be referred to as a "long-term release branch". For example
"release-2.11" is a long-term release branch, while "release-2.11.4" is a
short-term release branch.</li>
<li>Use of long-term release branches are OPTIONAL, and intended for work on
versions which are not currently part of the master branch. Typically
this is useful when you need to create a new maintenance release for a
older version.</li>
<li>A long-term release branch MUST have a name with a non-specific version
number. For example a long-term release branch for creating new 2.9.x
releases MUST be named "release-2.9".</li>
<li>Long-term release branches for maintenance releases of older versions
MUST be created from the relevant release tag. For example if the master
branch is on version 2.11.4 and there is a security fix for all 2.9.x
releases, the latest of which is "2.9.7". Create a new branch called
"release-2.9" off of the "2.9.7" release tag. The security fix release
will then end up being version "2.9.8".</li>
<li>To create a new release from a long-term release branch, you MUST follow
the same process as a release from the master branch, except the
long-term release branch takes the place of the master branch.</li>
<li>A long-term release branch should be treated with the same respect as the
master branch. It is effectively the master branch for the release series
in question. Meaning it MUST always be in a non-broken state, MUST NOT be
force pushed to, etc.</li>
</ol>
</li>
<li>Bug Fixes &amp; Rollback
<ol>
<li>You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.</li>
<li>If a change branch which has been merged into the master branch is found
to have a bug in it, the bug fix work MUST be done as a new separate
change branch and MUST follow the same workflow as any other change
branch.</li>
<li>If a change branch is wrongfully merged into master, or for any other
reason the merge must be undone, you MUST undo the merge by reverting the
merge commit itself. Effectively creating a new commit that reverses all
the relevant changes.</li>
</ol>
</li>
<li>Git Best Practices
<ol>
<li>All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<a href="https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines">https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines</a></li>
<li>You SHOULD never blindly commit all changes with "git commit -a". It is
RECOMMENDED you use "git add -i" or "git add -p" to add individual
changes to the staging area so you are fully aware of what you are
committing.</li>
<li>You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More
information:
<a href="https://developer.atlassian.com/blog/2015/04/force-with-lease/">https://developer.atlassian.com/blog/2015/04/force-with-lease/</a></li>
<li>You SHOULD understand and be comfortable with
rebasing: <a href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">https://git-scm.com/book/en/v2/Git-Branching-Rebasing</a></li>
<li>It is RECOMMENDED that you always do "git pull --rebase" instead of "git
pull" to avoid unnecessary merge commits. You can make this the default
behavior of "git pull" with "git config --global pull.rebase true".</li>
<li>It is RECOMMENDED that all branches be merged using "git merge --no-ff".
This makes sure the reference to the original branch is kept in the
commits, allows one to revert a merge by reverting a single merge commit,
and creates a merge commit to mark the integration of the branch with
master.</li>
</ol>
</li>
</ol>
<h2 id="faq">FAQ</h2>
<h3 id="why-use-common-flow-instead-of-git-flow-and-how-does-it-differ">Why use Common-Flow instead of Git Flow, and how does it differ?</h3>
<p>Common-Flow tries to be a lot less complicated than Git Flow by having fewer
types of branches, and simpler rules. Normal day to day development doesn't
really change much:</p>
<ul>
<li>You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.</li>
<li>Change branches are typically created off of and merged back into "master"
instead of "develop".</li>
<li>Creating a release is done by simply creating a git tag, typically on the
master branch.</li>
</ul>
<p>In detail, the main differences between Git Flow and Common-Flow are:</p>
<ul>
<li>There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.</li>
<li>There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.</li>
<li>Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.</li>
</ul>
<h3 id="why-use-common-flow-instead-of-github-flow-and-how-does-it-differ">Why use Common-Flow instead of GitHub Flow, and how does it differ?</h3>
<p>Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.</p>
<p>If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.</p>
<p>However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.</p>
<h3 id="what-does-descriptive-name-mean-for-change-branches">What does "descriptive name" mean for change branches?</h3>
<p>It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:</p>
<ul>
<li>add-2fa-support</li>
<li>fix-login-issue</li>
<li>remove-sort-by-middle-name-functionality</li>
<li>update-font-awesome</li>
<li>change-search-behavior</li>
<li>tweak-footer-style</li>
</ul>
<p>Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it's process.</p>
<h3 id="how-do-we-release-an-emergency-hotfix-when-the-master-branch-is-broken">How do we release an emergency hotfix when the master branch is broken?</h3>
<p>This should ideally never happen, however if it does you can do one of the
following:</p>
<ul>
<li>Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.</li>
<li>Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.</li>
</ul>
<p>In this situation, it is recommended you try to revert the offending changes
that's preventing a new release from master. But if that proves to be a
complicated task and you're short on time, a short-term release branch gives you
a instant fix to the situation at hand, and let's you resolve the issues with
the master branch when you have more time on your hands.</p>
<h2 id="about">About</h2>
<p>The Git Common-Flow specification is authored
by <a href="http://jimeh.me">Jim Myhrberg</a>.</p>
<p>If you'd like to leave feedback,
please <a href="https://github.com/jimeh/common-flow/issues">open an issue on GitHub</a>.</p>
<h2 id="license">License</h2>
<p><a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons - CC BY 3.0</a></p>
</div>
</div>
</div>
<script type="text/javascript" src="/assets/main-870855580c69dec57be4c965d0cf8afe78afa6b7b6f6bdb5aff91ac0256c0a1a.js"></script>
</body>
</html>

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

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 18 KiB

316
index.md
View File

@@ -1,11 +1,11 @@
--- ---
title: Git Common-Flow 1.0.0-rc.3 title: Git Common-Flow 1.0.0-rc.4
version: 1.0.0-rc.3 version: 1.0.0-rc.4
--- ---
Git Common-Flow 1.0.0-rc.3 Git Common-Flow 1.0.0-rc.4
=========================== ===========================
<img src="/spec/1.0.0-rc.3.svg" width="100%" /> <img src="/spec/1.0.0-rc.4.svg" width="100%" />
Summary Summary
------- -------
@@ -35,9 +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** - May be considered safe to use in production - **Release** - May be considered safe to use in production environments. Is
environments. Consists of a version bump commit, and a git tag named according effectively just a git tag named after the version of the release.
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.
@@ -64,110 +63,152 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
release. release.
3. 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".
branches MUST have descriptive names. It is RECOMMENDED that you commit 2. All change branches MUST have descriptive names.
often locally, and you SHOULD regularly push your work to the same named 3. It is RECOMMENDED that you commit often locally, and that you try and
branch on the remote server. keep the commits reasonably structured to avoid a messy and confusing git
2. You MUST create separate change branches for each distinctly different history.
change. You MUST NOT include multiple unrelated changes into a single 4. You SHOULD regularly push your work to the same named branch on the
remote server.
5. You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch. change branch.
3. When a change branch is created, the branch that it is created from 6. When a change branch is created, the branch that it is created from
SHOULD be referred to as the "source branch". Each change branch also 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. as the source branch.
4. Change branches MUST be regularly updated with any changes from their 7. Change branches MUST be regularly updated with any changes from their
source branch. This MUST be done by rebasing the change branch on top of source branch. This MUST be done by rebasing the change branch on top of
the source branch. the source branch.
5. After rebasing a change branch on top of its source branch you MUST push 8. After updating a change branch from its source branch you MUST push the
the change branch to the remote server. This will require you to do a change branch to the remote server. Due to the nature of rebasing, you
force push, and you SHOULD use the "--force-with-lease" git push option. will be required to do a force push, and you MUST use the
"--force-with-lease" git push option when doing so instead of the regular
"--force".
9. If there is a truly valid technical reason to not use rebase when
updating change branches, then you can update change branches via merge
instead of rebase. The decision to use merge MUST only be taken after all
possible options to use rebase have been tried and failed. People not
understanding how to use rebase is NOT a valid reason to use merge. If
you do decide to use merge instead of rebase, you MUST NOT use a mixture
of both methods, pick one and stick to it.
4. Pull Requests 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).
2. A pull request MUST only be merged when the change branch is up-to-date 2. The purpose of a pull request is to allow others to review your changes
and give feedback. You can then fix any issues, complaints, and more that
might arise, and then let people review again.
3. Before creating a pull request, it is RECOMMENDED that you consider the
state of your change branch's commit history. If it is messy and
confusing, it might be a good idea to rebase your branch with "git rebase
-i" to present a cleaner and easier to follow commit history for your
reviewers.
4. A pull request MUST only be merged when the change branch is up-to-date
with its source branch, the test suite is passing, and you and others are 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. is the master branch.
3. To get feedback, help, or generally just discuss a change branch with 5. 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.
5. Versioning 5. Versioning
1. The project MUST have its version hard-coded somewhere in the 1. A "version string" is a typically mostly numeric string that identifies a
code-base. It is RECOMMENDED that this is done in a file called "VERSION" specific version of a project. The version string itself MUST NOT have a
located in the root of the project. "v" prefix, but the version string can be displayed with a "v" prefix to
2. If you are using a "VERSION" file in the root of the project, this MUST indicate it is a version that is being referred to.
only contain the exact version string. 2. The source of truth for a project's version MUST be a git tag with a name
3. The version string SHOULD follow the Semantic Versioning based on the version string. This kind of tag MUST be referred to as a
(<http://semver.org/>) format. Use of Semantic Versioning is OPTIONAL, "release tag".
but the version string MUST NOT have a "v" prefix. For example "v2.11.4" 3. It is OPTIONAL, but RECOMMENDED to also keep the version string
is bad, and "2.11.4" is good. hard-coded somewhere in the project code-base.
6. Releases 4. If you hard-code the version string into the code-base, it is RECOMMENDED
1. To create a new release, you MUST create a "version bump" commit which that you do so in a file called "VERSION" located in the root of the
changes the hard-coded version string of the project. The version bump project. But be mindful of the conventions of your programming language
commit MUST have a git tag created on it and named as the exact version and community when choosing if, where and how to hard-code the version
string. string.
2. If you are not using a release branch, then the version bump commit MUST 5. If you are using a "VERSION" file in the root of the project, this file
be created directly on the master branch. MUST only contain the exact version string, meaning it MUST NOT have a
3. The version bump commit MUST have a commit message title of "Bump version "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
to VERSION". For example, if the new version string is "2.11.4", the 6. It is OPTIONAL, but RECOMMENDED that that the version string follows
first line of the commit message MUST read: "Bump version to 2.11.4" Semantic Versioning (<http://semver.org/>).
4. The release tag on the version bump commit MUST be named exactly the same 6. Releases
as the version string. The tag name can OPTIONALLY be prefixed with 1. To create a new release, you MUST create a git tag named as the exact
"v". For example the tag name can be either "2.11.4" or "v2.11.4". You version string of the release. This kind of tag MUST be referred to as a
MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form "release tag".
and stick to it. 2. The release tag name can OPTIONALLY be prefixed with "v". For example the
5. It is RECOMMENDED that release tags are lightweight tags, but you can tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED
that you do not use a "v" prefix. You MUST NOT use a mixture of "v"
prefixed and non-prefixed tags. Pick one form and stick to it.
3. If the version string is hard-coded into the code-base, you MUST create a
"version bump" commit which changes the hard-coded version string of the
project.
4. When using version bump commits, the release tag MUST be placed on the
version bump commit.
5. If you are not using a release branch, then the release tag, and if
relevant the version bump commit, MUST be created directly on the master
branch.
6. The version bump commit SHOULD have a commit message title of "Bump
version to VERSION". For example, if the new version string is "2.11.4",
the first line of the commit message SHOULD read: "Bump version to
2.11.4"
7. It is RECOMMENDED that release tags are lightweight tags, but you can
OPTIONALLY use annotated tags if you want to include changelog OPTIONALLY use annotated tags if you want to include changelog
information in the release tag itself. information in the release tag itself.
6. If you use annotated release tags, the first line of the annotation MUST 8. If you use annotated release tags, the first line of the annotation
read "Release VERSION". For example for version "2.11.4" the first line SHOULD read "Release VERSION". For example for version "2.11.4" the first
of the tag annotation would read "Release 2.11.4". The second line must line of the tag annotation SHOULD read "Release 2.11.4". The second line
be blank, and the changelog MUST start on the third line. MUST be blank, and the changelog MUST start on the third line.
7. Release Branches 7. Short-Term 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. Any release branch which has a name ending with a specific version
3. Changes in a release branch SHOULD typically come from work being string, MUST be referred to as a "short-term release branch".
done against the master branch. Meaning changes SHOULD only trickle 3. Use of short-term release branches are OPTIONAL, and intended to be used
downwards from the master branch. If a change needs to trickle back up to create a specific versioned release.
into the master branch, that work should have happened against the master 4. A short-term release branch is RECOMMENDED if there is a lengthy
branch in the first place. One exception to this is version bump commits. pre-release verification process to avoid a code freeze on the master
4. There are two types of release branches; short-term, and long-term. branch.
5. Short-Term Release Branches 5. Short-term release branches MUST have a name of "release-VERSION". For
1. Used for creating a specific versioned release. example for version "2.11.4" the release branch name MUST be
2. A short-term release branch is RECOMMENDED if there is a lengthy "release-2.11.4".
pre-release verification process to avoid a code freeze on the master 6. When using a short-term release branch to create a release, the release
branch. tag and if used, version bump commit, MUST be placed directly on the
3. MUST have a name of "release-VERSION". For example for version short-term release branch itself.
"2.11.4" the release branch name MUST be "release-2.11.4". 7. Only very minor changes should be performed on a short-term release
4. When using a short-term release branch, the version bump commit and branch directly. Any larger changes SHOULD be done in the master branch,
release tag MUST be made directly on the release branch itself. and SHOULD be pulled into the release branch by rebasing it on top of the
5. Only very minor changes should be performed on a short-term release master branch the same way a change branch pulls in updates from its
branch directly. Any larger changes SHOULD be done in the master source branch.
branch, and SHOULD be pulled into the release branch by rebasing it 8. After a release tag has been created, the release branch MUST be merged
on top of the master branch the same way a change branch pulls in back into its source branch and then deleted. Typically the source branch
updates from its source branch. will be the master branch.
6. After the version bump commit and release tag have been created, the 8. Long-term Release Branches
release branch MUST be merged back into its source branch and then 1. Any release branch which has a name ending with a non-specific version
deleted. Typically the source branch will be the master branch. string, MUST be referred to as a "long-term release branch". For example
6. Long-Term Release Branches "release-2.11" is a long-term release branch, while "release-2.11.4" is a
1. Used for work on versions which are not currently part of the master short-term release branch.
branch. Typically this is useful when you need to create a new 2. Use of long-term release branches are OPTIONAL, and intended for work on
maintenance release for a older version. versions which are not currently part of the master branch. Typically
2. The branch name MUST have a non-specific version number. For example this is useful when you need to create a new maintenance release for a
a long-term release branch for creating new 2.9.x releases would be older version.
named "release-2.9". 3. A long-term release branch MUST have a name with a non-specific version
3. To create a new release from a long-term release branch, you MUST number. For example a long-term release branch for creating new 2.9.x
create a version bump commit and release tag directly on the release releases MUST be named "release-2.9".
branch. 4. Long-term release branches for maintenance releases of older versions
4. A long-term release branch MUST be created from the relevant release MUST be created from the relevant release tag. For example if the master
tag. For example if the master branch is on version 2.11.4 and there branch is on version 2.11.4 and there is a security fix for all 2.9.x
is a security fix for all 2.9.x releases, the latest of which is releases, the latest of which is "2.9.7". Create a new branch called
"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" "release-2.9" off of the "2.9.7" release tag. The security fix release
release tag. The security fix release will then end up being version will then end up being version "2.9.8".
"2.9.8". 5. To create a new release from a long-term release branch, you MUST follow
8. Bug Fixes & Rollback the same process as a release from the master branch, except the
1. You MUST NOT under any circumstances force push to the master branch. long-term release branch takes the place of the master branch.
7. A long-term release branch should be treated with the same respect as the
master branch. It is effectively the master branch for the release series
in question. Meaning it MUST always be in a non-broken state, MUST NOT be
force pushed to, etc.
9. Bug Fixes & Rollback
1. You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.
2. If a change branch which has been merged into the master branch is found 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
change branch and MUST follow the same workflow as any other change change branch and MUST follow the same workflow as any other change
@@ -176,14 +217,15 @@ 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.
9. Git Best Practices 10. 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#_commit_guidelines> <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" or "git add -p" to add individual
area so you are fully aware of what you are committing. 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 3. 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:
@@ -199,6 +241,90 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
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. master.
FAQ
---
### Why use Common-Flow instead of Git Flow, and how does it differ?
Common-Flow tries to be a lot less complicated than Git Flow by having fewer
types of branches, and simpler rules. Normal day to day development doesn't
really change much:
- You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.
- Change branches are typically created off of and merged back into "master"
instead of "develop".
- Creating a release is done by simply creating a git tag, typically on the
master branch.
In detail, the main differences between Git Flow and Common-Flow are:
- There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.
- There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.
- Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.
### Why use Common-Flow instead of GitHub Flow, and how does it differ?
Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.
If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.
However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.
### What does "descriptive name" mean for change branches?
It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:
- add-2fa-support
- fix-login-issue
- remove-sort-by-middle-name-functionality
- update-font-awesome
- change-search-behavior
- tweak-footer-style
Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it's process.
### How do we release an emergency hotfix when the master branch is broken?
This should ideally never happen, however if it does you can do one of the
following:
- Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.
- Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.
In this situation, it is recommended you try to revert the offending changes
that's preventing a new release from master. But if that proves to be a
complicated task and you're short on time, a short-term release branch gives you
a instant fix to the situation at hand, and let's you resolve the issues with
the master branch when you have more time on your hands.
About About
----- -----

341
spec/1.0.0-rc.4.md Normal file
View File

@@ -0,0 +1,341 @@
---
title: Git Common-Flow 1.0.0-rc.4
version: 1.0.0-rc.4
---
Git Common-Flow 1.0.0-rc.4
===========================
<img src="/spec/1.0.0-rc.4.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. Is
effectively just a git tag named after the version of the release.
- **Release Branches** - Used both for short-term preparations of a release, and
also for long-term maintenance of older version.
Git Common-Flow Specification (Common-Flow)
-------------------------------------------
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
1. TL;DR
1. 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".
2. All change branches MUST have descriptive names.
3. It is RECOMMENDED that you commit often locally, and that you try and
keep the commits reasonably structured to avoid a messy and confusing git
history.
4. You SHOULD regularly push your work to the same named branch on the
remote server.
5. You SHOULD create separate change branches for each distinctly different
change. You SHOULD NOT include multiple unrelated changes into a single
change branch.
6. When a change branch is created, the branch that it is created from
SHOULD be referred to as the "source branch". Each change branch also
needs a designated "merge target" branch, typically this will be the same
as the source branch.
7. Change branches MUST be regularly updated with any changes from their
source branch. This MUST be done by rebasing the change branch on top of
the source branch.
8. After updating a change branch from its source branch you MUST push the
change branch to the remote server. Due to the nature of rebasing, you
will be required to do a force push, and you MUST use the
"--force-with-lease" git push option when doing so instead of the regular
"--force".
9. If there is a truly valid technical reason to not use rebase when
updating change branches, then you can update change branches via merge
instead of rebase. The decision to use merge MUST only be taken after all
possible options to use rebase have been tried and failed. People not
understanding how to use rebase is NOT a valid reason to use merge. If
you do decide to use merge instead of rebase, you MUST NOT use a mixture
of both methods, pick one and stick to it.
4. Pull Requests
1. To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent).
2. The purpose of a pull request is to allow others to review your changes
and give feedback. You can then fix any issues, complaints, and more that
might arise, and then let people review again.
3. Before creating a pull request, it is RECOMMENDED that you consider the
state of your change branch's commit history. If it is messy and
confusing, it might be a good idea to rebase your branch with "git rebase
-i" to present a cleaner and easier to follow commit history for your
reviewers.
4. A pull request MUST only be merged when the change branch is up-to-date
with its source branch, the test suite is passing, and you and others are
happy with the change. This is especially important if the merge target
is the master branch.
5. To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there.
5. Versioning
1. A "version string" is a typically mostly numeric string that identifies a
specific version of a project. The version string itself MUST NOT have a
"v" prefix, but the version string can be displayed with a "v" prefix to
indicate it is a version that is being referred to.
2. The source of truth for a project's version MUST be a git tag with a name
based on the version string. This kind of tag MUST be referred to as a
"release tag".
3. It is OPTIONAL, but RECOMMENDED to also keep the version string
hard-coded somewhere in the project code-base.
4. If you hard-code the version string into the code-base, it is RECOMMENDED
that you do so in a file called "VERSION" located in the root of the
project. But be mindful of the conventions of your programming language
and community when choosing if, where and how to hard-code the version
string.
5. If you are using a "VERSION" file in the root of the project, this file
MUST only contain the exact version string, meaning it MUST NOT have a
"v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good.
6. It is OPTIONAL, but RECOMMENDED that that the version string follows
Semantic Versioning (<http://semver.org/>).
6. Releases
1. To create a new release, you MUST create a git tag named as the exact
version string of the release. This kind of tag MUST be referred to as a
"release tag".
2. The release tag name can OPTIONALLY be prefixed with "v". For example the
tag name can be either "2.11.4" or "v2.11.4". It is however RECOMMENDED
that you do not use a "v" prefix. You MUST NOT use a mixture of "v"
prefixed and non-prefixed tags. Pick one form and stick to it.
3. If the version string is hard-coded into the code-base, you MUST create a
"version bump" commit which changes the hard-coded version string of the
project.
4. When using version bump commits, the release tag MUST be placed on the
version bump commit.
5. If you are not using a release branch, then the release tag, and if
relevant the version bump commit, MUST be created directly on the master
branch.
6. The version bump commit SHOULD have a commit message title of "Bump
version to VERSION". For example, if the new version string is "2.11.4",
the first line of the commit message SHOULD read: "Bump version to
2.11.4"
7. It is RECOMMENDED that release tags are lightweight tags, but you can
OPTIONALLY use annotated tags if you want to include changelog
information in the release tag itself.
8. If you use annotated release tags, the first line of the annotation
SHOULD read "Release VERSION". For example for version "2.11.4" the first
line of the tag annotation SHOULD read "Release 2.11.4". The second line
MUST be blank, and the changelog MUST start on the third line.
7. Short-Term Release Branches
1. Any branch that has a name starting with "release-" SHOULD be referred to
as a "release branch".
2. Any release branch which has a name ending with a specific version
string, MUST be referred to as a "short-term release branch".
3. Use of short-term release branches are OPTIONAL, and intended to be used
to create a specific versioned release.
4. A short-term release branch is RECOMMENDED if there is a lengthy
pre-release verification process to avoid a code freeze on the master
branch.
5. Short-term release branches MUST have a name of "release-VERSION". For
example for version "2.11.4" the release branch name MUST be
"release-2.11.4".
6. When using a short-term release branch to create a release, the release
tag and if used, version bump commit, MUST be placed directly on the
short-term release branch itself.
7. Only very minor changes should be performed on a short-term release
branch directly. Any larger changes SHOULD be done in the master branch,
and SHOULD be pulled into the release branch by rebasing it on top of the
master branch the same way a change branch pulls in updates from its
source branch.
8. After a release tag has been created, the release branch MUST be merged
back into its source branch and then deleted. Typically the source branch
will be the master branch.
8. Long-term Release Branches
1. Any release branch which has a name ending with a non-specific version
string, MUST be referred to as a "long-term release branch". For example
"release-2.11" is a long-term release branch, while "release-2.11.4" is a
short-term release branch.
2. Use of long-term release branches are OPTIONAL, and intended for work on
versions which are not currently part of the master branch. Typically
this is useful when you need to create a new maintenance release for a
older version.
3. A long-term release branch MUST have a name with a non-specific version
number. For example a long-term release branch for creating new 2.9.x
releases MUST be named "release-2.9".
4. Long-term release branches for maintenance releases of older versions
MUST be created from the relevant release tag. For example if the master
branch is on version 2.11.4 and there is a security fix for all 2.9.x
releases, the latest of which is "2.9.7". Create a new branch called
"release-2.9" off of the "2.9.7" release tag. The security fix release
will then end up being version "2.9.8".
5. To create a new release from a long-term release branch, you MUST follow
the same process as a release from the master branch, except the
long-term release branch takes the place of the master branch.
7. A long-term release branch should be treated with the same respect as the
master branch. It is effectively the master branch for the release series
in question. Meaning it MUST always be in a non-broken state, MUST NOT be
force pushed to, etc.
9. Bug Fixes & Rollback
1. You MUST NOT under any circumstances force push to the master branch or
to long-term release branches.
2. If a change branch which has been merged into the master branch is found
to have a bug in it, the bug fix work MUST be done as a new separate
change branch and MUST follow the same workflow as any other change
branch.
3. If a change branch is wrongfully merged into master, or for any other
reason the merge must be undone, you MUST undo the merge by reverting the
merge commit itself. Effectively creating a new commit that reverses all
the relevant changes.
10. Git Best Practices
1. All commit messages SHOULD follow the Commit Guidelines and format from
the official git
documentation:
<https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines>
2. You SHOULD never blindly commit all changes with "git commit -a". It is
RECOMMENDED you use "git add -i" or "git add -p" to add individual
changes to the staging area so you are fully aware of what you are
committing.
3. You SHOULD always use "--force-with-lease" when doing a force push. The
regular "--force" option is dangerous and destructive. More
information:
<https://developer.atlassian.com/blog/2015/04/force-with-lease/>
4. You SHOULD understand and be comfortable with
rebasing: <https://git-scm.com/book/en/v2/Git-Branching-Rebasing>
5. It is RECOMMENDED that you always do "git pull --rebase" instead of "git
pull" to avoid unnecessary merge commits. You can make this the default
behavior of "git pull" with "git config --global pull.rebase true".
6. It is RECOMMENDED that all branches be merged using "git merge --no-ff".
This makes sure the reference to the original branch is kept in the
commits, allows one to revert a merge by reverting a single merge commit,
and creates a merge commit to mark the integration of the branch with
master.
FAQ
---
### Why use Common-Flow instead of Git Flow, and how does it differ?
Common-Flow tries to be a lot less complicated than Git Flow by having fewer
types of branches, and simpler rules. Normal day to day development doesn't
really change much:
- You create change branches instead of feature branches, without the need of a
"feature/" or "change/" prefix in the branch name.
- Change branches are typically created off of and merged back into "master"
instead of "develop".
- Creating a release is done by simply creating a git tag, typically on the
master branch.
In detail, the main differences between Git Flow and Common-Flow are:
- There is no "develop" branch, there is only a "master" branch which contains
the latest work. In Git Flow the master branch effectively ends up just being
a pointer to the latest release, despite the fact that Git Flow includes
release tags too. In Common-Flow you just look at the tags to find the latest
release.
- There are no "feature" or "hotfix" branches, there's only "change"
branches. Any branch that is not master and introduces changes is a change
branch. Change branches also don't have a enforced naming convention, they
just have to have a "descriptive name". This makes things simpler and allows
more flexibility.
- Release branches are available, but optional. Instead of enforcing the use of
release branches like Git Flow, Common-Flow only recommends the use of release
branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that.
### Why use Common-Flow instead of GitHub Flow, and how does it differ?
Common-Flow is essentially GitHub Flow with the addition of a "Release" concept
that uses tags. It also attempts to define how certain common tasks are done,
like updating change/feature branches from their source branches for
example. This is to help end arguments about how such things are done.
If a deployment/release for you is just getting the latest code in the master
branch out, without caring about bumping version numbers or anything, then
GitHub Flow is a good fit for you, and you probably don't need the extras of
Common-Flow.
However if your deployments/releases have specific version numbers, then
Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does.
### What does "descriptive name" mean for change branches?
It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:
- add-2fa-support
- fix-login-issue
- remove-sort-by-middle-name-functionality
- update-font-awesome
- change-search-behavior
- tweak-footer-style
Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it's process.
### How do we release an emergency hotfix when the master branch is broken?
This should ideally never happen, however if it does you can do one of the
following:
- Review why the master branch is broken and revert the changes that caused the
issues. Then apply the hotfix and release.
- Or use a short-term release branch created from the latest release tag instead
of the master branch. Apply the hotfix to the release branch, create a release
tag on the release branch, and then merge it back into master.
In this situation, it is recommended you try to revert the offending changes
that's preventing a new release from master. But if that proves to be a
complicated task and you're short on time, a short-term release branch gives you
a instant fix to the situation at hand, and let's you resolve the issues with
the master branch when you have more time on your hands.
About
-----
The Git Common-Flow specification is authored
by [Jim Myhrberg](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.4.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 18 KiB