Browse Source

updating readme with gitflow workflow

Dan Hassan 2 years ago
parent
commit
ec496baac1
1 changed files with 17 additions and 0 deletions
  1. 17
    0
      README.md

+ 17
- 0
README.md View File

@@ -22,3 +22,20 @@ yarn test:unit
22 22
 
23 23
 ### Customize configuration
24 24
 See [Configuration Reference](https://cli.vuejs.org/config/).
25
+
26
+### Repo Process
27
+We're following the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). Please base off of `develop` when working on `feature/<feature_name>` branches. This should be a branch per feature.
28
+
29
+#### Example
30
+A complete example demonstrating a Feature Branch Flow is as follows. Assuming we have a repo setup with a master branch.
31
+```
32
+git checkout master
33
+git checkout -b develop
34
+git checkout -b feature_branch
35
+# work happens on feature branch
36
+git checkout develop
37
+git merge feature_branch
38
+git checkout master
39
+git merge develop
40
+git branch -d feature_branch
41
+```