Skip to content

Commit 40dc773

Browse files
committed
Reorganize structure
Signed-off-by: Ayush P Gupta <ayushpguptaapg@gmail.com>
1 parent c1276b2 commit 40dc773

File tree

16 files changed

+8
-8
lines changed

16 files changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![](VCS%20v2.0%20Proposal%20001%20(2).001.png)
1+
![](img/001.png)
22
FieldAssist
33

44
**VCS (Git) v2.0**
@@ -43,7 +43,7 @@ Drilling down and after brainstorming we came with our new Git Branching model w
4343
1. Linear history would enable us to cherry pick commits easily.
4444
1. With proper commit message/branch naming standards we can easily identify the purpose of commit and subsequent PR
4545

46-
**OVERVIEW OF NEW SYSTEM![](VCS%20v2.0%20Proposal%20001%20(2).002.png)**
46+
**OVERVIEW OF NEW SYSTEM![](img/002.png)**
4747

4848
The new branching model is an enhanced version of [Git-flow](https://nvie.com/posts/a-successful-git-branching-model/) that tries to solve the previous diagnosed issues by defining different branches as below:
4949

@@ -174,7 +174,7 @@ Pull request can be merged by admins in three ways (actually there are four, but
174174

175175
Hence all team members will use **Rebase and merge** option when merging PR of individual members into their respective team develop branch.
176176

177-
![](VCS%20v2.0%20Proposal%20001%20(2).007.png)
177+
![](img/007.png)
178178

179179
**BEST PRACTICES**
180180

@@ -197,15 +197,15 @@ If we religiously follow the above pattern we would have a pretty organized stru
197197

198198
Looks awesome?
199199

200-
![](VCS%20v2.0%20Proposal%20001%20(2).009.png)
200+
![](img/009.png)
201201

202202
**Commit Message**
203203

204204
Proper commit message should be entered while committing your work. Your commit message should follow following standards:
205205

206206
1. Commit message should have a prefix indicating the feature/highlight of the nature of work in commit. For example:
207207

208-
![](VCS%20v2.0%20Proposal%20001%20(2).010.png)
208+
![](img/010.png)
209209

210210
This will clearly indicate what commit message corresponds to what feature/bug in commit history. Helpful after merge and releases are complete.
211211

@@ -247,7 +247,7 @@ Every merge to either **develop** or **master** must have the latest commit as *
247247

248248
**Rebasing** is a process to reapply commits on top of another base trip. This must be done regularly or just before raising PR to the base branch.
249249

250-
![](VCS%20v2.0%20Proposal%20001%20(2).012.png)
250+
![](img/012.png)
251251

252252
In the above figure, the feature branch is no more with latest changes in master because some other members did work on master. Hence to have linear git history and prevent merge conflicts feature branch is **rebased on-to master** so as to make its commit appear **on top of the latest master.**
253253

@@ -259,7 +259,7 @@ $ git rebase master // The branch on which you will raise PR
259259

260260
**ff (Fast forward) merge vs no-ff merge**
261261

262-
![](VCS%20v2.0%20Proposal%20001%20(2).014.png)
262+
![](img/014.png)
263263

264264
Feature branches can be merged in two ways. Either by **ff-merge** or by **--no-ff merge.** No ff merge would create **merge commit** while maintaining the history of merge. This is helpful when merging **hotfix branches** where merge history is required.
265265

@@ -269,7 +269,7 @@ On the other hand, **ff merge** would simply merge the feature branch on-to mast
269269

270270
Sometimes code related or code review type discussions are needed with other members, hence often we add a prefix **WIP** to the title of PR. Such PR should not be merged as the work is still in progress. Once the WIP thing is over, the author of PR must remove the WIP prefix to get it reviewed & merged.
271271

272-
![](VCS%20v2.0%20Proposal%20001%20(2).015.png)
272+
![](img/015.png)
273273

274274
**FURTHER READING**
275275

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)