• This repository has been archived on 09/Aug/2023
  • Stars
    star
    135
  • Rank 269,297 (Top 6 %)
  • Language
  • Created almost 9 years ago
  • Updated over 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

πŸ”€ Branching strategies! For Git!
         `@@@:               `@@@:                                                        `@@@:   
        #@+:;@@             #@+:;@@                                                      #@+:;@@  
       #@:::::+@       @   #@:::::+@                                                    #@:::::+@
       @:::::::@;      @@  @:::::::@;                                                   @:::::::@;
      .@:::::::;@      @@@.@:::::::;@                                                  .@:::::::;@
      ;@::::::::@@@@@@@@@@@@::::::::@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@::::::::@
      `@:::::::+@      @@#`@:::::::+@                                                  `@:::::::+@
       @:::::::@`      @#  @:::::::@`                                                   @:::::::@`
       .@:::::@#       #   .@:::::@@:                                               @@@@@@:::::@#
        .@@@@@#       .     .@@@@@#.@#                                               @@@@.@@@@@#  
          `;.                 `;.    @@                                              '@@@  `;.    
                                      @@                                            @@`@@         
                                       @@`                                         @@  ;#         
                                        '@:    ;                                  @@    '         
                                         .@#  `+                                .@#               
                                           @@ @@                               '@;                
                                            @@@@                              @@`                 
                                            '@@@ #@@@@`               #@@@@` @@                   
                                           #@@@@@#,,,;@,        .    @#,,,;@@@                    
                                          ,    @+,,,,,,@        @.  @+,,,,,,@                     
                                               @,,,,,,,#+       @@. @,,,,,,,#+                    
                                              ,@,,,,,,,:@@@@@@@@@@@@@,,,,,,,:@                    
                                              ,@,,,,,,,:@@@@@@@@@@@@@,,,,,,,:@                    
                                               @,,,,,,,#+       @@. @,,,,,,,#+                    
                                               @+,,,,,,@        @.  @+,,,,,,@                     
                                                @#,,,;@,        .    @#,,,;@,                     
                                                 #@@@@`               #@@@@`                      

Mobify Branching Strategy

This document represents Mobify's current branching and release strategy. It provides a brief overview of the two release models that we use: release deployment and continuous deployment.

Each workflow tries to make things as simple as possible while still being flexible enough to work for all teams at Mobify.

At the end of each document is a list of common scenarios you will encounter and how Mobify's branching strategies apply.

What is the purpose of this document?

As Mobify continues to grow and expand its operations globally, consistency across all teams and partners is a key focus. The more aligned all Mobify projects are, the more productive everyone will be.

This repository and its documentation outline:

  • How we develop features
  • When and how we create a release
  • What to do when a hot fix is required
  • Anything else related to our branching strategy

This document is not...

Written in stone. Pull requests welcome! We will iterate on this document based on feedback.

The one true way to work on projects. There are edgecases and this document does not intent to answer them all.

A guide on deployment or workflows. Build deployment and workflow strategies on top of these branching models in a way that best fits your team.

Project Types

Depending on the type of project, one of two branching strategies is used:

Continuous Deployment

Use this strategy for projects where features get deployed as soon as they're ready.

Learn more

Release Deployment

Use this strategy for projects where features get bundled into a release and then deployed together.

Learn more

Branch Naming

Branch naming is left mostly up to the discretion of the person creating the branch with a few exceptions. master and develop are always named exactly that. When a feature/bugfix is related to a JIRA ticket we prefer that the branch name start with the ticket number (eg. hyb-545-add-headerbar). Hotfix and release branches should follow a pattern defined in the project type documents (ie. release-vX.Y.Z or (eg. hotfix-hyb-244-fix-db-connection-code), but feature and bugfix branches do not need a common prefix (ie. feature-*).

Branch names should use dashes to separate words of the name and should avoid any uppercase letters.

Other than that, choose names that are descriptive and concise. You don't need a branch name that is a novel because most branches should be relatively short-lived (hours to days, not weeks).

Git @ Mobify

Mobify uses git (specifically Github) for all source control. Git is a very flexible tool and we have adopted some patterns when using git specifically at Mobify. Think of it as the git equivalent of "Javascript - The Good Parts." :)

Updating branches

** Important **

Git always works on a local copy of a repository. As a result, whenever you do any operations that involve multiple branches (eg. merge) be sure to update both branches before performing the operation.

git pull

Git provides a single command to update your local branch with changes from a remote. git pull is this command. Most of the time it does exactly what you want without any problems, but you should know that git pull is really git fetch followed by git merge. So when you pull from a remote, you're actually updating the remote tracking branch (eg. origin/mybranch) and then merging that into your local branch mybranch.

It's good to know that this happens under the hood. Some people prefer to do the git fetch and git merge operations separately. Most of the time git pull will do what you want and is an acceptable way to update your local branch with changes from remote.

Protected Branches

GitHub recently added Protected branches. Protected branches:

  • Can't be force pushed
  • Can't be deleted
  • Can't have changes merged into them until required status checks pass

master and develop branches should always be protected. These protected branches should never be directly committed to. They should only be updated through PR merges.

Projects that have continuous integration with a service such as CircleCI should have their master and develop (if applicable) branches protected by a status check requiring CircleCI builds to pass before changes can be merged.

Anti-Patterns

After reading all of the above, none of the Anti-Patterns should come as a surprise.

More Repositories

1

mobifyjs

Mobify.js was a JavaScript framework for optimizing sites for mobile. It is no longer actively maintained.
JavaScript
646
star
2

pikabu

Off-Canvas flyout menu
HTML
453
star
3

iterstuff

Useful tools for working with iterators
Python
169
star
4

bellows

A responsive, mobile-first accordion UI module for progressive disclosure on the web.
JavaScript
140
star
5

scooch

A mobile-first JavaScript-driven content and image carousel
JavaScript
125
star
6

mobify-code-style

πŸ“š Mobify's coding style and standards!
Python
117
star
7

handbooks

A collection of Mobify's internal handbooks and styleguides
90
star
8

developer-values

πŸ™Œ Principles to follow when building software.
76
star
9

commercecloud-ocapi-client

Salesforce Commerce Cloud Open Commerce API (OCAPI) for Node and browsers πŸ›’
JavaScript
70
star
10

nightwatch-commands

A set of Mobify specific custom commands for Nightwatch.js
JavaScript
60
star
11

magnifik

An image zooming module for mobile
JavaScript
54
star
12

sass-sleuth

Adapts Webkit Web Inspector to handle Sass line number debugging information
36
star
13

mobify-client

Mobify CLI and Tools for use with the Mobify.js Adaptation Framework
JavaScript
23
star
14

pinny

A mobile-first content fly-in UI plugin
JavaScript
23
star
15

mobify-modules

DEPRECATED! See https://github.com/mobify/mobify.github.io
CSS
23
star
16

meowbify

🐈 Meowbify
CoffeeScript
17
star
17

mobifyjs-demos

Demo mobile sites created using Mobify.js
JavaScript
15
star
18

hijax

XHR Proxy to intercept AJAX calls independent of libraries.
JavaScript
13
star
19

spline

⚠️ DEPRECATED. Spline is a mixin and function library for Sass. It makes writing stylesheets for mobile-first builds faster and easier. Spline provides methods to manipulate text, use web & icon fonts, create CSS3 shapes, and much more.
CSS
11
star
20

ui-kit

πŸ“± Quickly and efficiently design PWAs for ecommerce brands.
10
star
21

hybris-occ-client

πŸ› Hybris Omni Commerce Connect (OCC) client for Node and browsers.
HTML
9
star
22

capturejs

Transform your DOM to be your API for your front-end application
JavaScript
9
star
23

mobify-data-guide

πŸ“š List of readings that would be useful in getting started on with working with any data set.
7
star
24

vellum

Default project styles for a mobile-first AdaptiveJS build.
HTML
5
star
25

redux-runtypes-schema

Redux store validation via runtypes
TypeScript
5
star
26

deckard

Device OS and Browser detection
HTML
5
star
27

astro-scaffold

πŸ— Starting point for building Astro applications!
JavaScript
4
star
28

split-test

An A/B split test library for persisting split choices
JavaScript
4
star
29

stencil

DEPRECIATED - The latest Stencil development is currently taking place in the Adaptive.js repo.
CSS
4
star
30

imageresize-client

Client code for the Mobify image resizing API
HTML
4
star
31

hora.js

Hora.js: Custom Google Analytics Tracking
HTML
3
star
32

lockup

A mobile first scroll blocking plugin.
HTML
3
star
33

navitron

A mobile optimized sliding navigation plugin.
JavaScript
3
star
34

tozee

Alphabet scroll jumping
HTML
3
star
35

python-appfigures

API wrapper for the appfigures.com
Python
3
star
36

webpush-payload-encryption

Python code to handle the encryption of push notifications for Firefox and Chrome
Python
3
star
37

calypso

A set of tools for better Docker deployments to AWS Elastic Beanstalk.
Python
3
star
38

multiple-service-workers

Experimenting with multiple service workers
HTML
2
star
39

shade

A mobile-first plugin for creating scroll and touch blocking overlays for content
JavaScript
2
star
40

jazzcat-client

Client code for Mobify's javascript optimization service
JavaScript
2
star
41

level

⚠️ DEPRECATED. CST's own personal Normalize
CSS
2
star
42

styleandclass-planning

Style & Class Meetup Public Site
2
star
43

css-optimize

The client-library for optimizing CSS using the Jazzcat service
JavaScript
2
star
44

webpayments-test

πŸ’³ PaymentRequest browser API demo.
JavaScript
2
star
45

schemer

Schema comparison tool for Adaptive projects
JavaScript
2
star
46

dmit

Wrap docker-machine in useful functionality
Shell
2
star
47

descript

Manage desktop scripts in a simple way in Adaptive.js
HTML
2
star
48

heroku-buildpack-openssl

Buildpack for OpenSSL 1.0.2e on Heroku
Shell
2
star
49

selector-utils

Selector utility functions that can be selectively included in your Adaptive.js builds.
JavaScript
1
star
50

generator-nightwatch

A yeoman generator for Nightwatch testing framework
JavaScript
1
star
51

deprecated-mobify-tech-prtnr-na03-dw

The Demandware Demonstration Integration
CSS
1
star
52

stencil-fancy-select

A fancier select replacement component using Javascript
CSS
1
star
53

generator-progressive-web

❗️DEPRECATED❗️-- Generator for creating Progressive Web projects
Shell
1
star
54

adaptivejs-split-test-examples

Split test examples for Adaptive.js!
JavaScript
1
star
55

depot

A collection of mobile-focused lo-fi wireframe components built in Photoshop.
1
star
56

stencil-tabs

JavaScript
1
star