Changes between Version 7 and Version 8 of StartModWorkflow

Timestamp:

Dec 10, 2013, 3:46:17 PM (9 years ago)

Author:

Beman Dawes

Comment:

--

StartModWorkflow

@@ -3 +3 @@
 
 Workflow is the term used to describe the steps a Boost library developer follows to create and maintain a library.
+
+== Git Flow ==
  
-The workflow model Boost recommends is nowadays called '''Git Flow'''. It was introduced as a simple [http://nvie.com/posts/a-successful-git-branching-model/ blog posting] by Vincent Driessen on January 5th, 2010, that went viral and has become a widely used software engineering practice.
+The workflow model Boost recommends is called '''Git Flow'''. It was introduced as a simple [http://nvie.com/posts/a-successful-git-branching-model/ blog posting] by Vincent Driessen on January 5th, 2010, that went viral and has become a widely used software engineering practice.
 
 This workflow has arguably become so successful because it scales well from very small to very large projects, and that's one of the reasons it is recommended (but not required) for Boost libraries.
@@ -14 +16 @@
 The Git Flow model diagram is available as a [http://github.com/downloads/nvie/gitflow/Git-branching-model.pdf PDF file] - print it out and hang it on your wall!
 
+== Command line tools ==
+
 For those who use Git from the command line, [https://github.com/nvie/gitflow git-flow command line tools] are available to automate common operations. See [https://github.com/nvie/gitflow/wiki git-flow wiki] for more information.
 
+== Branch names ==
+
+All Boost libraries are required to have two branches:
+
+* {{{master}}} is always the library's latest release. It should always be stable.
+* {{{develop}}} is always the main development branch. Whether it is always stable or not is up to the individual library.
+
+ These branches are require so that Boost's release management and other scripts can use known branch names.
+
+While Boost libraries are not required to use the following branches, it is strongly encouraged that these naming conventions are followed if the branches are present.
+
+* {{{feature/descriptive-name}}} for feature branches. For example, {{{feature/add-roman-numeral-math}}}.
+* {{{bugfix/descriptive-name}}} for bug-fix branches, including hotfixes. For example, {{{bugfix/ticket-1234-crash-if-result-negative}}}
+* {{{release.n.n.n}}} for release staging branches. For example, {{{release.1.56.2}}}.
+ 
 == Aside: Deleting merged branches ==
 
@@ -24 +43 @@
 keeps the commit history alive and there's no longer any need to keep
 the old label around.  If you delete a branch without merging it, of
-course, any commit history exclusively referenced by that branch is
+course, any content and commit history exclusive to that branch is
 lost.