Skip to content

Commit c6b635f

Browse files
peer review
1 parent fd9237b commit c6b635f

1 file changed

Lines changed: 20 additions & 17 deletions

File tree

  • content/en/docs/refguide/version-control/using-version-control-in-studio-pro

content/en/docs/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,23 @@ Both options support the following features when it comes to [resolving the conf
2121

2222
* Fine-grained conflict resolution – When there are conflicting changes in a document, you do not have to choose between whole documents, resolving a conflict using your change or using their change. Instead, you can resolve conflicts at the level of individual elements, such as widgets, entities, attributes, or microflow actions. All non-conflicting changes from both sides are accepted automatically.
2323
* No conflicts on changes to lists of widgets – When two developers make changes to widgets in the same document there is no conflict, the changes are combined. However, if the changes are made too close to the same place in the document, a list order conflict is reported that reminds the developer who is merging the changes to decide on the final order of the widgets in the list.
24-
* Can be aborted at any time. Studio Pro will continue from your latest local commit.
24+
* They can be aborted at any time. Studio Pro will continue from your latest local commit.
2525

2626
The differences between the two approaches are as follows:
2727

28-
* Rebase (*default*):
29-
* Treats changes from the server as leading, by first retrieving the server state and then reapplying your work to it.
28+
* Rebase (default):
29+
* Treats changes from the server as leading, by first retrieving the server state, and then reapplying your work to it.
3030
* Results in a simple commit history.
31-
* Resolves conflicts when reapplying your local commits. If you have 3 local commits, this could trigger conflict resolution 3 times.
31+
* Resolves conflicts when reapplying your local commits. If you have three local commits, this could trigger conflict resolution three times.
3232
* Merge commit:
33-
* Treats local and remote changes equally, and combines them in a separate 'merge commit'.
33+
* Treats local and remote changes equally, and combines them in a separate merge commit.
3434
* Results in a more complicated commit history with extra merge commits.
3535
* Resolves conflicts once, regardless of the number of local and remote commits being merged.
3636

3737
{{% alert color="info" %}}
3838
In general, Mendix recommends using the Rebase strategy when combining changes, especially when actively collaborating on the same branch.
3939

40-
In exceptional cases, for example when you have a lot of local commits where you expect conflicts, a merge commit might be the better choice.
40+
In exceptional cases, for example when you have a lot of local commits where you expect conflicts, a merge commit may be the better choice.
4141
{{% /alert %}}
4242

4343
Both processes are guided by [notification controls](#notifications) showing the actual state and possible next steps.
@@ -48,33 +48,36 @@ The clearest way to explain and illustrate the differences between Rebase and Me
4848

4949
### Starting Point
5050

51-
There are two entities `User` and `Game` which you have added to the domain model of your project.
51+
To start this scenario, let us assume that you have added the following entities to the domain model of your project:
5252

53-
The User entity includes string attributes `E_mail` and `Second_E_mail`.
53+
* `User`
54+
* `Game`
55+
56+
The User entity includes the string attributes `E_mail` and `Second_E_mail`.
5457

5558
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/DomainModel/Starting_State.png" >}}
5659

57-
### Local Changes, Your Work
60+
### Your Local Changes
5861

59-
During your work you make two changes, each one in separate commit.
62+
During your work you make the following changes, each one in separate commit:
6063

61-
In the first commit you rename `E_mail` to `Email`
64+
* Rename `E_mail` to `Email`.
6265

63-
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/DomainModel/First_Local_Commit.png" >}}
66+
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/DomainModel/First_Local_Commit.png" >}}
6467

65-
In the next commit you rename `Second_E_mail` to `Second_Email` to be consistent with previous change.
68+
* Rename `Second_E_mail` to `Second_Email`.
6669

67-
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/DomainModel/Second_Local_Commit.png" >}}
70+
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/DomainModel/Second_Local_Commit.png" >}}
6871

69-
### Server Changes
72+
### Another User's Changes
7073

71-
In the meantime, your colleague also decided to make some changes to both email fields. They have renamed `E_mail` to `EmailAddress` and removed `Second_E_mail` entirely. These changes have been pushed to the server.
74+
In the meantime, your colleague also decided to make changes to both email fields. They have renamed `E_mail` to `EmailAddress` and removed `Second_E_mail` entirely. They have then pushed their changes to the server.
7275

7376
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/DomainModel/Remote_State.png" >}}
7477

7578
### Summary
7679

77-
The current situation could be represent as shown below.
80+
The current situation could be represented as shown below.
7881

7982
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/merge-algorithm/Steps/Rebase_Starting_state.png" alt="Team Server with three commits (1, 2, and 4), while in Studio Pro there are also three commits (1, 3, and 5)" width="525" >}}
8083

0 commit comments

Comments
 (0)