Define git workflow with some examples

[faizanvahevaria]

All the basic Git Features like

1. Init
2. Clone
3. Push
4. Pull

are implemented using the StarUML extension

I need more details on how the user would expect the extension to work.

Will the user be creating i.e. initializing new repo?
or just clone from existing repo and use Model Interchange format to update their graphs.

If you can define some workflows, it would be helpful in improving the user experience.

[kshychko]

@faizanvahevaria , as we discussed, I don't think we nee to minmise the number of actions available for user to avoid additional confiusion. If a user needs advanced git functionality, git CLI or some other tool can be used for that.

So let's start simple.
We expect the git repo to be already initialised and cloned. If not - sure error/warning message saying that the repo wasn't initialised, or it just can't be detected.

We need a "sync" button, which will create a commit from the current changes. Pull the changes from remote and rebase the created commit on them, push the local branch remotely. If there are any conflicts ask a user to resolve them using git cli or other tool and repeat the sync process.

Also we need "show me what was changed" to compare the local and the remote before sync. I'm not sure what is the best way to do - show a diff, or comparing a content of two files side by side. The aim is to make the information about the changes available to user.

I also have a feeling that our Git extension should probably work only with files in interchange format, and ignore the other files like StarUML projects, so users will not be racing updating the repo with their mdj files.

[faizanvahevaria]

@kshychko
Where we can have this option in our extension ?

Also we need "show me what was changed" to compare the local and the remote before sync. I'm not sure what is the best way to do - show a diff, or comparing a content of two files side by side. The aim is to make the information about the changes available to user.

[faizanvahevaria]

@kshychko
Please test this feature from latest code.
Also let me know your answer about this comment : #15 (comment)

Tools -> Git -> Init/Clone
1. Enter repository URL
2. Select local path where to clone your repository

Tools -> Git -> Sync
1. If any local changes ->
- Enter username, email, password
- Enter commit message
- Push
2. If no any local changes -> Pull and reset