Tips, Tricks & Good Citizenship

What has version control got to do with good citizenship? How does this relate to code? How is your company culture and release policy reflected in your version control choices?

Join me in discussing how branching techniques can affect code conflicts and see what can happen when clever tools get too big for their boots!

An updated version of my June 2016 talk, given in July 2016 at @WorcSource; includes a clearer animated progress version of git lab flow style branching strategies.

Transcript

1. VERSION CONTROL
   TIPS, TRICKS & GOOD CITIZENSHIP
   

   View Slide

2. @CRATAEGUSTESS
   TESS BARNES
   • multi language developer
   • currently working for Fasthosts
   • tech lead
   • agile advocate
   • mental wellness advocate
   

   View Slide

3. HOPEFULLY…
   WHAT WE WILL COVER
   • how good citizenship fits in
   • fundamentals
   • conflict resolution
   • branching
   • documentation
   • the right tool for the right reasons
   

   View Slide

4. GOOD (CODE) CITIZENSHIP
   WHAT’S IT ALL ABOUT?
   

   View Slide

5. EDUCATIONAL DEFINITION
   GOOD CITIZENSHIP
   Good citizens should always try to make a team-minded decision during any situation.
   Knowing what is right and wrong and understanding the consequences of a decision are
   important aspects of being a good citizen.
   Obeying laws and having respect for not only individuals in the community, but for the
   community itself, are other traits of a good citizen.
   Being helpful or helping those in need is another aspect of being a good citizen.
   from http://www.ask.com/world-view/qualities-good-citizen-5a9b527e5fe4adbc
   

   View Slide

6. HTTPS://OSMIHELP.ORG
   HTTPS://
   WWW.INDIEGOGO.COM/
   PROJECTS/OPEN-SOURCING-
   MENTAL-ILLNESS-2016/
   @OSMIHELP
   

   View Slide

7. WHAT’S IT GOT TO DO WITH CODE?
   GOOD (CODE) CITIZENSHIP
   • version control is the hub of a bigger system
   

   View Slide

8. WHAT’S IT GOT TO DO WITH CODE?
   GOOD (CODE) CITIZENSHIP
   • version control is the hub of a bigger system
   • creating something great to build on
   

   View Slide

9. WHAT’S IT GOT TO DO WITH CODE?
   GOOD (CODE) CITIZENSHIP
   • version control is the hub of a bigger system
   • creating something great to build on
   • keeping our house clean
   

   View Slide

10. WHAT’S IT GOT TO DO WITH CODE?
    GOOD (CODE) CITIZENSHIP
    • version control is the hub of a bigger system
    • creating something great to build on
    • keeping our house clean
    • doing what we agreed
    

    View Slide

11. WHAT’S IT GOT TO DO WITH CODE?
    GOOD (CODE) CITIZENSHIP
    • version control is the hub of a bigger system
    • creating something great to build on
    • keeping our house clean
    • doing what we agreed
    • sharing what we know
    

    View Slide

12. WHAT’S IT GOT TO DO WITH CODE?
    GOOD (CODE) CITIZENSHIP
    • version control is the hub of a bigger system
    • creating something great to build on
    • keeping our house clean
    • doing what we agreed
    • sharing what we know
    • inviting feedback
    

    View Slide

13. WHAT’S IT GOT TO DO WITH CODE?
    GOOD (CODE) CITIZENSHIP
    • version control is the hub of a bigger system
    • creating something great to build on
    • keeping our house clean
    • doing what we agreed
    • sharing what we know
    • inviting feedback
    • moving forward together
    

    View Slide

14. THE FUNDAMENTALS
    CREATING SOMETHING GREAT TO BUILD ON
    

    View Slide

15. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    

    View Slide

16. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    • lots of tools available, some good, some awful
    

    View Slide

17. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    • lots of tools available, some good, some awful
    • sharing code
    

    View Slide

18. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    • lots of tools available, some good, some awful
    • sharing code • integrating code
    

    View Slide

19. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    • lots of tools available, some good, some awful
    • sharing code
    • safeguarding code snapshots
    • integrating code
    

    View Slide

20. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    • lots of tools available, some good, some awful
    • sharing code
    • safeguarding code snapshots
    • integrating code
    • allowing easy rollback
    

    View Slide

21. HIGH LEVEL VIEW
    THE FUNDAMENTALS
    • version control is a keystone of good development practices
    • lots of tools available, some good, some awful
    • sharing code
    • safeguarding code snapshots
    • not just code
    • integrating code
    • allowing easy rollback
    

    View Slide

22. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    

    View Slide

23. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    • refresh (1…n)
    

    View Slide

24. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    • refresh (1…n)
    

    View Slide

25. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    • refresh (1…n)
    

    View Slide

26. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    • refresh (1…n)
    • test (1…n)
    

    View Slide

27. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    3. merge
    • refresh (1…n)
    • test (1…n)
    

    View Slide

28. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    3. merge
    • refresh (1…n)
    • test (1…n)
    

    View Slide

29. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    3. merge
    4. snapshot
    • refresh (1…n)
    • test (1…n)
    

    View Slide

30. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    3. merge
    4. snapshot
    5. release
    • refresh (1…n)
    • test (1…n)
    

    View Slide

31. THE SEQUENCE
    THE FUNDAMENTALS
    1. separate
    2. change
    3. merge
    4. snapshot
    5. release
    • refresh (1…n)
    • test (1…n)
    • sanity check
    

    View Slide

32. HANDLING CONFLICTS
    DOING WHAT WE AGREED
    

    View Slide

33. HANDLING CONFLICTS
    • some version control tools handle this better than others
    

    View Slide

34. View Slide

35. HANDLING CONFLICTS
    • some version control tools handle this better than others
    • some tools hide issues
    

    View Slide

36. namespace RecipeForum;
    class Cleaver
    {
    private $weightInGrams;
    private $lengthInInch;
    private $percentSharp = 100;
    private $percentSteel;
    public function __construct($weightInGrams,
    $lengthInInch, $percentSteel)
    {
    $this->weightInGrams = $weightInGrams;
    $this->lengthInInch = $lengthInInch;
    $this->percentSteel = $percentSteel;
    }
    public function Sharpen($sharpener)
    {
    $this->weightInGrams -= 0.01;
    $this->percentSharp = 100;
    }
    public function Cut($foodItem)
    {
    $this->percentSharp -=1;
    }
    }
    namespace RecipeForum;
    class Cleaver
    {
    private $loyaltyScore;
    private $age;
    private $favouriteChef;
    private $dateJoined;
    public function __construct($age,
    $loyaltyScore, $dateJoined)
    {
    $this->age = $age;
    $this->loyaltyScore = $loyaltyScore;
    $this->dateJoined = $dateJoined;
    }
    public function setFavouriteChef($chefId)
    {
    $this->favouriteChef = $chefId;
    }
    }
    

    View Slide

37. View Slide

38. HANDLING CONFLICTS
    • some version control tools handle this better than others
    • some tools hide issues
    • remember - the conflict is in the code, design or interpretation, not the tool
    

    View Slide

39. HANDLING CONFLICTS
    • some version control tools handle this better than others
    • some tools hide issues
    • remember - the conflict is in the code, design or interpretation, not the tool
    • how you branch / merge affects when, not if your conflicts occur
    

    View Slide

40. BRANCHING STRATEGIES
    KEEPING OUR HOUSE CLEAN
    

    View Slide

41. BRANCHING STRATEGIES
    DISTRIBUTED OR SINGLE SERVER
    origin
    clone 1 clone 2
    clone
    pull
    fetch
    merge
    request
    server / repo
    check in
    check out
    update
    working copy 1
    working copy 2
    working copy 3
    

    View Slide

42. BRANCHING STRATEGIES
    IS BRANCHING CHEAP?
    

    View Slide

43. BRANCHING STRATEGIES
    DEVELOPER OVERLAP? HOW DO YOU FEEL ABOUT SHARING?
    

    View Slide

44. BRANCHING STRATEGIES
    RELEASE FOCUS OR FEATURE FOCUS
    v1.1
    v1.2
    clone / push
    master
    merge
    merge
    branch
    1.1 branch
    1.2
    v5.1
    MR
    MR
    MR
    master
    F1
    F2
    F3
    

    View Slide

45. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    fetch /
    pull
    clone1
    

    View Slide

46. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    fetch /
    pull
    clone1
    MR / push
    

    View Slide

47. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    fetch /
    pull
    clone1
    MR
    MR / push
    

    View Slide

48. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    fetch /
    pull
    clone1
    tag
    MR
    MR / push
    

    View Slide

49. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    fetch /
    pull
    clone1 clone2
    tag
    MR
    

    View Slide

50. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    MR / push
    fetch /
    pull
    clone1 clone2
    tag
    MR
    

    View Slide

51. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    MR
    MR / push
    fetch /
    pull
    clone1 clone2
    tag
    

    View Slide

52. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    MR
    MR / push
    fetch /
    pull
    clone1 clone2
    

    View Slide

53. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    MR
    fetch /
    pull
    clone1 clone2 clone3
    

    View Slide

54. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    MR
    fetch /
    pull
    clone1 clone2
    MR / push
    clone3
    

    View Slide

55. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    live hot fix
    MR
    fetch /
    pull
    clone1 clone2
    MR / push
    clone3
    

    View Slide

56. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    live hot fix
    MR
    fetch /
    pull
    clone1 clone2
    MR / push
    clone3
    

    View Slide

57. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    live hot fix
    MR
    fetch /
    pull
    clone1 clone2
    tag
    MR / push
    clone3
    

    View Slide

58. BRANCHING STRATEGIES
    CONTINUOUS INTEGRATION
    master
    production
    tag
    live hot fix
    MR
    fetch /
    pull
    MR
    clone1 clone2
    MR / push
    clone3
    tag
    

    View Slide

59. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1
    master
    

    View Slide

60. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1
    master
    MR / push
    

    View Slide

61. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    MR / push
    

    View Slide

62. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1
    master
    clone2
    MR
    MR / push
    

    View Slide

63. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    clone2
    MR
    

    View Slide

64. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    clone2
    MR /
    push
    MR
    

    View Slide

65. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    clone2
    MR /
    push
    fetch /
    pull
    MR
    

    View Slide

66. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    clone2
    MR /
    push
    

    View Slide

67. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    clone2
    fetch /
    pull
    

    View Slide

68. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    MR
    clone2
    fetch /
    pull
    

    View Slide

69. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    clone2
    tag
    fetch /
    pull
    MR
    

    View Slide

70. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    clone2
    tag
    MR / push
    MR
    

    View Slide

71. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    clone2
    MR / push
    tag live hot fix
    MR
    

    View Slide

72. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    MR
    clone2
    tag
    MR / push
    live hot fix
    MR
    

    View Slide

73. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    clone1 clone3
    master
    tag
    MR
    clone2
    MR / push
    live hot fix
    MR
    

    View Slide

74. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    fetch /
    pull
    MR
    clone1 clone3
    master
    tag
    MR
    clone2
    MR / push
    live hot fix
    MR
    

    View Slide

75. BRANCHING STRATEGIES
    MULTIPLE DEPLOYMENT ENVIRONMENTS
    staging
    production
    live hot fix
    fetch /
    pull
    MR
    clone1 clone3
    master
    tag
    MR
    MR
    clone2
    MR / push
    MR
    

    View Slide

76. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR
    clone2
    MR /
    push
    

    View Slide

77. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR
    MR /
    push
    live hot fix
    clone2
    

    View Slide

78. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    clone2
    

    View Slide

79. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    CHERRYPICK MR
    clone2
    

    View Slide

80. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    tag
    CHERRYPICK MR
    MR
    clone2
    

    View Slide

81. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    MR
    clone2
    

    View Slide

82. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    MR
    live hot fix
    clone2
    

    View Slide

83. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    MR
    clone2
    

    View Slide

84. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    CHERRYPICK MR
    MR
    clone2
    

    View Slide

85. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    CHERRYPICK MR
    CHERRYPICK MR
    MR
    clone2
    

    View Slide

86. BRANCHING STRATEGIES
    LIVE HOT FIXES USING CHERRYPICKING
    staging
    production
    fetch /
    pull
    clone1
    master
    MR
    tag
    MR /
    push
    MR
    live hot fix
    tag
    CHERRYPICK MR
    CHERRYPICK MR
    MR
    clone2
    

    View Slide

87. DOCUMENTATION
    SHARING WHAT WE KNOW & INVITING FEEDBACK
    

    View Slide

88. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct
    

    View Slide

89. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative
    

    View Slide

90. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful
    

    View Slide

91. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful, consistent
    

    View Slide

92. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful, consistent, agreed
    

    View Slide

93. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful, consistent, agreed
    • could be scraped for release notes - respect your intended audience
    

    View Slide

94. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful, consistent, agreed
    • could be scraped for release notes - respect your intended audience
    • linked to issue and story trackers - don’t duplicate data
    

    View Slide

95. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful, consistent, agreed
    • could be scraped for release notes - respect your intended audience
    • linked to issue and story trackers - don’t duplicate data
    • used for code review in merge requests
    

    View Slide

96. THE ART OF A GOOD COMMIT MESSAGE (IMO)
    DOCUMENTATION
    • succinct, informative, meaningful, consistent, agreed
    • could be scraped for release notes - respect your intended audience
    • linked to issue and story trackers - don’t duplicate data
    • used for code review in merge requests
    • pattern enforced using commit hooks
    

    View Slide

97. ADDITIONAL THOUGHTS
    DOCUMENTATION
    • expected practices for open source (e.g. git hub templates)
    

    View Slide

98. ADDITIONAL THOUGHTS
    DOCUMENTATION
    • expected practices for open source (e.g. git hub templates)
    • .gitmessage encouraging why & how over ‘one liners‘

    https://robots.thoughtbot.com/better-commit-messages-with-a-gitmessage-
    template
    • what (title)
    

    View Slide

99. ADDITIONAL THOUGHTS
    DOCUMENTATION
    • expected practices for open source (e.g. git hub templates)
    • .gitmessage encouraging why & how over ‘one liners‘

    https://robots.thoughtbot.com/better-commit-messages-with-a-gitmessage-
    template
    • what (title)
    • why (link to feature)
    

    View Slide

100. ADDITIONAL THOUGHTS
     DOCUMENTATION
     • expected practices for open source (e.g. git hub templates)
     • .gitmessage encouraging why & how over ‘one liners‘

     https://robots.thoughtbot.com/better-commit-messages-with-a-gitmessage-
     template
     • what (title)
     • why (link to feature)
     • how (details - pitched for your audience)
     

     View Slide

101. RIGHT TOOL FOR THE RIGHT JOB
     MOVING FORWARD TOGETHER
     

     View Slide

102. RIGHT TOOL FOR THE RIGHT JOB
     •
     

     View Slide

103. NOT EVERYONE USES GIT!
     RIGHT TOOL FOR THE RIGHT JOB
     • git is distributed, prolific, popular and practically required for open source
     

     View Slide

104. NOT EVERYONE USES GIT!
     RIGHT TOOL FOR THE RIGHT JOB
     • git is distributed, prolific, popular and practically required for open source
     • but there are still other tools out there…
     ➡ older companies and legacy projects? Subversion?
     ➡ proprietary code? Mercurial?
     ➡ c# houses? TFS?
     

     View Slide

105. RESPECT YOUR COMMUNITY
     RIGHT TOOL FOR THE RIGHT JOB
     • the first priority may not be to change version control tool
     

     View Slide

106. RESPECT YOUR COMMUNITY
     RIGHT TOOL FOR THE RIGHT JOB
     • the first priority may not be to change version control tool
     • make sure you’re fixing the right problems
     

     View Slide

107. RESPECT YOUR COMMUNITY
     RIGHT TOOL FOR THE RIGHT JOB
     • the first priority may not be to change version control tool
     • make sure you’re fixing the right problems
     • the more you know your tools, the more powerful they become
     

     View Slide

108. RESPECT YOUR COMMUNITY
     RIGHT TOOL FOR THE RIGHT JOB
     • the first priority may not be to change version control tool
     • make sure you’re fixing the right problems
     • the more you know your tools, the more powerful they become
     • choose a version control system that suits your business
     

     View Slide

109. RESPECT YOUR COMMUNITY
     RIGHT TOOL FOR THE RIGHT JOB
     • the first priority may not be to change version control tool
     • make sure you’re fixing the right problems
     • the more you know your tools, the more powerful they become
     • choose a version control system that suits your business
     • most importantly… know WHY
     

     View Slide

110. View Slide

111. View Slide

112. THANK YOU FOR
     LISTENING
     TESS BARNES @CRATAEGUSTESS
     

     View Slide

113. HTTPS://OSMIHELP.ORG
     HTTPS://
     WWW.INDIEGOGO.COM/
     PROJECTS/OPEN-SOURCING-
     MENTAL-ILLNESS-2016/
     @OSMIHELP
     

     View Slide