Skip to content

Commit

Permalink
update docs for github flows
Browse files Browse the repository at this point in the history
  • Loading branch information
patricksimonian committed May 9, 2019
1 parent 99cf9d8 commit 3c226dd
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions github/flow.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
---
title: The Right Flow for the Job
title: Git Workflows For Your Team or Project
description: There are several best practices for working in Github with respect to branching, pull requests, and commits. The two most popular are Git Flow and Github Flow.
author: patricksimonian
image: ../images/branch.png
---
## Git Flow vs. Github Flow
## Git Workflows For Your Team or Project

A great explanation of the differences between these two flows can be found [here](https://www.freshconsulting.com/git-development-workflows-git-flow-vs-github-flow/)
A Git workflow describes a pattern for you and possibly your team to follow when contributing code to a project.
These patterns often include strategies to handle certain tasks in the lifecycle of an application or project including
- adding features
- fixing bugs
- addressing security vulnerabilites

The two most popular flows are called __Git Flow__ and ___GitHub Flow___

A great explanation of the differences between these two flows can be found [here](https://www.freshconsulting.com/git-development-workflows-git-flow-vs-github-flow/).

### Starting a Project? Which Flow is the Right Flow?

There is not a 'right' flow. Both flows at the end of the day provide well documented and tested strategies for publishing code.
Discuss with your team as well as other teams who have adopted these flows to gather an oppinion and choose the best flow
for your project.

### Teams or Projects Using Git Flow
- My Range BC (https://github.com/bcgov/range-web)
- ___Pull Request Your Team into this list!___

### Teams or Projects Using Github Flow
- Devhub (https://github.com/bcgov/devhub-app-web)
- Mines Digital Service (MDS) (https://github.com/bcgov/mds)

0 comments on commit 3c226dd

Please sign in to comment.