Skip to content

Commit fbb9cf9

Browse files
committed
Wrote merging to shared development
1 parent 64492f1 commit fbb9cf9

File tree

1 file changed

+46
-5
lines changed

1 file changed

+46
-5
lines changed

docs/Developer/GitFlow.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ gitGraph TB:
9696

9797
### Feature branches
9898

99-
Our shared development branch is considered to be the main branch, in terms of being the latest functioning code (which may or may not be ready for merging into master and creating a release). So, all personal development branches start off as functioning code and are not merged back into the shared development branch until they are once again functioning code. Until then, features are branched off of the personal development and merged back into personal development.
99+
Our shared development branch is considered to be the main branch, in terms of being the latest functioning code (which may or may not be ready for merging into master and creating a release) and so is the source for creation of all personal development branches. So, all personal development branches start off as functioning code and are not merged back into the shared development branch until they are once again functioning code. Until then, features are branched off of the personal development and merged back into personal development (with pull requests, tests, and code reviews).
100100

101101
```mermaid
102102
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'themeVariables': {
103-
'git0': '#FFBF00',
103+
'git0': '#8FED0A',
104104
'git1': '#A4A4A4',
105105
'git2': '#A4A4A4'
106106
},'gitGraph': {'rotateCommitLabel': true, 'showBranches': true, 'showCommitLabel':true, 'mainBranchName': 'AUserDev'}} }%%
@@ -124,10 +124,51 @@ Our shared development branch is considered to be the main branch, in terms of b
124124
merge FeatureB tag: "merged featureB"
125125
```
126126

127-
### Merging to Master Branch
128-
The master and development branches exist parallel to one another. We consider the development branch to be the main branch where the source code always reflects a state with the latest delivered development changes. Once the development branch is ready to merge back to the master, we create a release branch (not supported in our document). Our version can either cherry-pick the developments we want into the master or revert the changes and merge to the master and re-revert the changes (not supported in the document).
127+
### Merging to Shared Development
128+
129+
The shared and personal development branches exist parallel to one another. We consider the shared development branch to be the main branch where the source code always reflects a state with the latest delivered development changes. The personal development branches, on the other hand, may be in a state in which the code is "broken", i.e., in the middle of a sequence of feature branch changes that will, incrementally, produce fully working code. So, one principle is that we don't merge code into the shared development branch until the associated line of development is complete. At that point, we double-check that the personal development branch isn't behind shared development and generate a pull request to merge it.
130+
131+
132+
```mermaid
133+
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'themeVariables': {
134+
'git0': '#FFBF00',
135+
'git1': '#8FED0A',
136+
'git2': '#A4A4A4',
137+
'git3': '#A4A4A4',
138+
'git4': '#A4A4A4'
139+
},
140+
'gitGraph': {'rotateCommitLabel': true, 'showBranches': true, 'showCommitLabel':false,'mainBranchName': 'SharedDev'}} }%%
141+
gitGraph TB:
142+
commit id: "Version 1.1"
143+
branch AUserDev
144+
checkout AUserDev
145+
commit id: "initial commit NG911"
146+
branch FeatureA
147+
commit id: "[ISSUE-412] Name Of Issue"
148+
commit id: "merge ready" type: HIGHLIGHT tag:"Review"
149+
checkout AUserDev
150+
commit id: "ready to release"
151+
branch FeatureB
152+
checkout AUserDev
153+
merge FeatureA id: "merged featureA"
154+
checkout AUserDev
155+
checkout FeatureB
156+
commit type: HIGHLIGHT tag: "Review "
157+
checkout AUserDev
158+
merge FeatureB
159+
checkout AUserDev
160+
checkout SharedDev
161+
merge AUserDev
162+
checkout AUserDev
163+
commit
164+
```
165+
166+
### Merging to Master
167+
168+
169+
170+
Once the development branch is ready to merge back to the master, we create a release branch (not supported in our document). Our version can either cherry-pick the developments we want into the master or revert the changes and merge to the master and re-revert the changes (not supported in the document).
129171

130-
[![](https://mermaid.ink/img/pako:eNqNVNFumzAU_RXLU8QLjQIhAfyWrEkaKe2kpevDxh4cuCFWACNj2tGIf58xZSNr1xTEg8-99_ici69POOQRYIIHgxPLmCTohIyExxt4hMQgyIhgV8aGiQx5gBQaZEcL-AM8UMHoLoFCRU5BhtRjxEyOmsRP9sKfLReG-Re3NL5czpejUR-3NT5zmrePj_-DO308yGoVauCVoPmhUWIILqmEzzxNmdzQnfYiRQlKd3HgT3NBs_CgVffQs_Q9TQowjZSyrM2-o63_W1pIEEZdo3owCLJuW3Q_J1pgqFkQiwgK8AOIgvEMWUMrwDq802Toumkwz1PIZFt1gPDIS_k60KdrfhGjSQferXzrH94lUFkKmL2u_bHebr8trhzL_okaL-jLHq2LooQXgrPkFEQMSACNqgAjWeVA0M16dbNR3z2SNCYB_gqPDJ666g_p14RIcsWcgDpHb2qfv0_YSut89vVGaN-5vySqC5xv2Up9yy3q7KJL1Gfy5h-U0Z6pnoguLER1lbPw-H7_LjQfm01_1EmO1KDrKQ2wnt4AN6QRFceGqFZ5tJR8W2UhJnoucJlHao6uGY0FTfHLUGCImOTitr059AVi4pxm3zlPu0K1xOSEf2EynQxdb2pPHNf3PGti-yauMBk7Q8udup5l-QqaeHZt4mddPxr6jj9yXcd2x55rj91J_Rvb4n0O?type=png)](https://mermaid.live/edit#pako:eNqNVNFumzAU_RXLU8QLjQIhAfyWrEkaKe2kpevDxh4cuCFWACNj2tGIf58xZSNr1xTEg8-99_ici69POOQRYIIHgxPLmCTohIyExxt4hMQgyIhgV8aGiQx5gBQaZEcL-AM8UMHoLoFCRU5BhtRjxEyOmsRP9sKfLReG-Re3NL5czpejUR-3NT5zmrePj_-DO308yGoVauCVoPmhUWIILqmEzzxNmdzQnfYiRQlKd3HgT3NBs_CgVffQs_Q9TQowjZSyrM2-o63_W1pIEEZdo3owCLJuW3Q_J1pgqFkQiwgK8AOIgvEMWUMrwDq802Toumkwz1PIZFt1gPDIS_k60KdrfhGjSQferXzrH94lUFkKmL2u_bHebr8trhzL_okaL-jLHq2LooQXgrPkFEQMSACNqgAjWeVA0M16dbNR3z2SNCYB_gqPDJ666g_p14RIcsWcgDpHb2qfv0_YSut89vVGaN-5vySqC5xv2Up9yy3q7KJL1Gfy5h-U0Z6pnoguLER1lbPw-H7_LjQfm01_1EmO1KDrKQ2wnt4AN6QRFceGqFZ5tJR8W2UhJnoucJlHao6uGY0FTfHLUGCImOTitr059AVi4pxm3zlPu0K1xOSEf2EynQxdb2pPHNf3PGti-yauMBk7Q8udup5l-QqaeHZt4mddPxr6jj9yXcd2x55rj91J_Rvb4n0O)
131172

132173
## Detailed Run-Through of Making a Release
133174

0 commit comments

Comments
 (0)