jimeh/common-flow
1
0
Fork 0
mirror of https://github.com/jimeh/common-flow.git synced 2026-02-19 09:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve style of FAQ section

Browse Source
This commit is contained in:
Jim Myhrberg
2017-08-26 23:51:24 +01:00
parent 6735136a5d
commit d3e6630e2e
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
common-flow.md
View File

@@ -238,7 +238,7 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
FAQ FAQ
--- ---
**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?
Common-Flow tries to be a lot less complicated than Git Flow by having fewer Common-Flow tries to be a lot less complicated than Git Flow by having fewer
types of branches, and simpler rules. Normal day to development doesn't really types of branches, and simpler rules. Normal day to development doesn't really
@@ -268,7 +268,7 @@ In detail, the main differences between Git Flow and Common-Flow are:
branches when it makes things easier. If creating a new release by tagging branches when it makes things easier. If creating a new release by tagging
"master" works for you, great, do that. "master" works for you, great, do that.
**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?
Common-Flow is essentially GitHub Flow with the addition of a "Release" concept 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, that uses tags. It also attempts to define how certain common tasks are done,
@@ -284,7 +284,7 @@ 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 Common-Flow gives you a simple set of rules of how to create and manage
releases, on top of what GitHub Flow already does. releases, on top of what GitHub Flow already does.
**What does "descriptive name" mean in terms of change branches?** ### What does "descriptive name" mean in terms of change branches?
It means what it sounds like. The name should be descriptive, as in by just 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 reading the name of the branch you should understand what the branch's purpose
@@ -302,14 +302,13 @@ 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 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. ticket number prefixes if your team/org has that as part of it's process.
**What if there's a emergency hotfix that needs to be released, but for whatever ### How do we release an emergency hotfix when the master branch is broken?**
reason, the master branch has changes that cannot be released right now?**
This should ideally never happen, as it most likely means the master branch is This should ideally never happen, however if it does you can do one of the
broken. However if it does happen, you can do one of the following: following:
- Review why the master branch can't be deployed, and revert the changes that - Review why the master branch is broken and revert the changes that caused the
are preventing a release. Then apply the hotfix and release. issues. Then apply the hotfix and release.
- Or use a short-term release branch created from the latest release tag instead - 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 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. tag on the release branch, and then merge it back into master.
@@ -318,7 +317,7 @@ 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 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 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 a instant fix to the situation at hand, and let's you resolve the issues with
the master branch when you have time. the master branch when you have more time on your hands.
About About
----- -----