View source for Developing FreeCAD with GitKraken/de

<languages/>

<span id="Foreword"></span>
== Vorwort ==

{{TOCright}}

FreeCAD verwendet [https://git-scm.com/ Git] zur Verwaltung des Quellcodes. Dieses Dokument ist eine oberflächliche Einführung in [https://www.gitkraken.com/ GitKraken], eine grafische Benutzeroberfläche von Git. GitKraken ist eine proprietäre Software, die für den nicht kommerziellen Gebrauch kostenlos ist; du brauchst GitKraken nicht, um Code für FreeCAD zu entwickeln, aber viele Entwickler mögen es und finden es nützlich, ihre Entwicklung zu verwalten. FreeCAD unterstützt GitKraken nicht, aber wir hoffen, dass ein Leitfaden wie dieser den Anwendern zeigt, wie einfach es ist, die Entwicklungsumgebung einzurichten, und ermutigt mehr Menschen, sich zu beteiligen.

Weitere Informationen zur allgemeinen Git Nutzung über die Befehlszeile findest Du unter [[Source code management|Source code management]] und im Online Buch [https://git-scm.com/book/en/v2 Pro Git]. Zur Kompilierung von FreeCAD siehe [[Compiling/de| Kompilieren]].

<span id="Introduction"></span>
== Einführung ==

Git ist ein leistungsfähiges Revisionskontrollsystem, das häufig verwendet wird, um die Entwicklung von Computercode zu verfolgen. Obwohl es sich um ein komplexes System handelt, benötigst Du in der Regel nur einige Hintergrundinformationen über die Funktionsweise und einige wenige Terminalbefehle. Eine grafische Benutzeroberfläche (GUI) erleichtert die Lernkurve. [https://www.gitkraken.com/ GitKraken] ist ein proprietäres Programm, das für den nicht kommerziellen Gebrauch kostenlos ist und auf dem Gerüst [https://electronjs.org Electron] läuft, d.h. es ist plattformübergreifend und kann unter Linux, MacOS und Windows gleichermaßen verwendet werden.

<span id="Setting_up_Git_development"></span>
== Einrichten der Git Entwicklung ==

Es gibt unterschiedliche Wege zum Herunterladen von GitKraken, abhängig von Deinem Betriebssystem. In Linux Distributionen kann man es manchmal über den Paketmanager beziehen.

<ol> 
  <li>GitKraken Herunterladen.</li>
  <li>Gehe in deinem Webbrowser zu: {{URL|https://github.com/FreeCAD/FreeCAD}}.<br>

[[File:Github-Fork-button.png]]

  </li>
  <li>Click the '''Fork''' button. This will clone the {{incode|FreeCAD/FreeCAD}} repository to your own account. In other words the URL to access your fork will be:

<pre>
https://github.com/GITHUBUSERNAME/FreeCAD.git
</pre>

  <li> Öffne GitKraken, gehe zu {{MenuCommand|Datei → Klone Repo}}, und gib diese addresse ein.<br>

[[File:GitKraken-Clone-Repo-dialogue.png]]

  </li>
    <li>GitKraken wird nun dein persönliches Repositorium {{incode|git klonen}}.

Please read the difference between [https://stackoverflow.com/questions/9257533/what-is-the-difference-between-origin-and-upstream-on-github#9257901 origin vs. upstream] remote repository. Essentially, your fork of FreeCAD is the {{incode|origin}} repository, while the official FreeCAD repository is {{incode|upstream}}. You now need to set the upstream accordingly.</li>
  <li>Locate the sidebar in Gitkraken. There is a '''Local''' and '''Remote''' section. Local refers to your local branches. Remote refers to remote repositories and their branches. Lets add the FreeCAD repo as a remote. In the '''Remote''' section click the {{Button|+}} (as illustrated in the image below).<br>

[[File:Gitkraken-remote-sidebar.png]]

  </li>
  <li>An '''Add Remote''' dialog will open. Click the Github symbol (1). In the '''Github repo''' field (2) find the {{incode|FreeCAD/FreeCAD}} and click on it. In the '''Name''' field, type {{incode|upstream}}. Then click the {{Button|Add Button}}.<br>

[[File:Gitkraken-add-remote-dark.png|400px]]

  </li>
  <li>The dialog will close and switch back to GitKraken main interface. This time find the '''Local''' section in the sidebar; double click on the {{incode|master}} branch so you switch to it. In the command line, this is equivalent to

<pre>
git checkout master
</pre>

  </li>
  <li>Click on the '''Push''' icon on the top right side of the interface. This will push your '''Local master''' to your '''Remote origin master'''</li>
</ol>

<span id="The_GitKraken_interface"></span>
== Die GitKraken Oberfläche ==

Für weitere Informationen konsultiere GitKraken [https://support.gitkraken.com/start-here/guide/ Erste Schritte Leitfaden].

{| class="wikitable"
|-
|+ ''Local'' indicates your local machine
|-
| Local master || Your local branch of the FreeCAD master branch, indicated by the '''blue''' line in the screenshot.

The item is highlighted in '''green''', meaning that the branch is currently active ({{incode|git checkout}}).
|-
| Local <branch-name> || Any other branches on your local machine. In the screenshot you can see branches called {{incode|editor_fixes}} and {{incode|editor_fixes_typos}}
|}

{| class="wikitable"
|-
|+ ''Remote'' indicates a remote repository, for example in GitHub
|-
| Remote upstream || The official FreeCAD repository {{URL|https://github.com/FreeCAD/FreeCAD}}, indicated by the '''green''' line in the screenshot.
|-
| Remote origin || Your personal fork of FreeCAD, {{URLn|https://github.com/YourGitHubUsername/FreeCAD}}, indicated by the '''red''' line in the screenshot.
|}
[[File:GitKraken-Main-Screen-sm.jpg]]

{{Caption|GitKraken interface showing three local branches including a local {{Emphasis|master}}, and remote {{incode|origin}} and {{incode|upstream}} repositories, each of which have a master and release branches.}}
In the image, the remote the '''Local master''' and '''Remote origin master''' branches are three commits behind the '''Remote upstream master''', that is, the official FreeCAD source code. This is indicated by the icons being three steps behind in the chain that represents the commit history of the master branch. See [[Developing_FreeCAD_with_GitKraken#Rebasing|Rebasing]] to update the branches that are behind.

== Rebasing ==

* Checkout the '''Local master''' branch by double clicking on it ({{incode|git checkout master}})
* Move the mouse to the last upstream commit, right click, and choose '''Rebase master onto upstream/master''' ({{incode|git pull upstream master}})
* Now press the '''Push''' button ({{incode|git push origin master}}). This pushes from your '''Local master''' to the '''Remote origin master'''.

[[File:GitKraken-Rebasing.gif]]

{{Caption|Rebasing a local master updates it so that it matches the contents of the upstream master.}}

<span id="Branches"></span>
== Zweige ==

Branches are a feature that makes Git powerful compared to other revision systems. Branches aren't complete forks, but rather define snapshots where a version of the code starts diverging from the master branch. Whenever you want to modify the FreeCAD code, first create a branch, then make changes, and then merge your commits back to the master branch. With Git it is simple to create, merge and delete branches when you no longer need them. Please read [https://support.gitkraken.com/working-with-repositories/branching-and-merging Branching and Merging] to understand more about this process in GitKraken.

# Make sure you currently have the master branch active (double click on it, {{incode|git checkout master}}). In GitKraken the '''Local master''' branch should be highlighted in '''green'''.
# Click the '''Branch''' button to create a new branch and enter its new name ({{incode|git checkout -b new-name-of-your-branch}}).

<span id="Making_pull_requests"></span>
== Pull Anfragen stellen ==

[https://help.github.com/articles/about-pull-requests/ Pull requests] (PRs) are necessary to merge the code in a branch in your local repository with the code in the {{incode|upstream}} repository. To summarize the process, once you've modified your branch, you need to push it to your GitHub fork ({{incode|origin}}, {{URLn|https://github.com/GITHUBUSERNAME/FreeCAD.git}}), and from there make a pull request to {{incode|upstream}}. GitKraken saves you some clicks to easily create pull requests instead of using GitHub's interface.

Steps in GitKraken:
* Find you local branch on the interface and make sure it's active (double click on it).
* Right click the branch name and find the option to '''Push <your-branch-name> and start a pull request'''.
:GitKraken will open a dialog that asks you to confirm the repository which your branch will use to pull and push. It will then push your local branch to that remote repository.
[[File:Gitkraken-How to PR.png]]
* GitKraken will ask you what you want to call the remote branch. The default name is the same name that the branch has locally in your computer.
[[File:Gitkraken-How-to-PR-Prompt-for-Branch-name.png|1200px]]
* GitKraken then opens up another dialog asking the repositories and branches to merge, and the direction (from and to).
:You normally want to merge from the remote '''origin <your-branch-name>''' ({{incode|GITHUBUSERNAME/FreeCAD}}) to the remote '''upstream master''' branch ({{incode|FreeCAD/FreeCAD}}). Be sure to enter a good title for the pull request, and write a more descriptive paragraph if your changes are significant. Consult the official documentation of [https://support.gitkraken.com/working-with-repositories/pull-requests GitKraken] for more information.
[[File:Gitkraken-How-to-PR-Github-Dialog-breakdown.png]]

<span id="Resolving_merge_conflicts"></span>
== Auflösen von Zusammenführungskonflikten ==

GitKraken has a special merge conflict tool that is only accessible in the GitKraken Pro version. However, there are workarounds to use external tools for merging.
* [https://support.gitkraken.com/working-with-repositories/branching-and-merging/ GitKraken compatible external merge tools]: Beyond Compare, FileMerge, Kaleidoscope, KDiff, Araxis, P4Merge
* If none of the above options work for you, it's possible to specify [https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_external_merge_tools External merge and diff tools] within the configuration file {{incode|~/.gitconfig}} in your user's home directory.

== Squashing commits ==

As a revision control system Git encourages making many commits to keep track of your changes; however, if you have too many small changes the commit history may look a bit messy. Squashing is condensing various commits into only one commit. From the [https://support.gitkraken.com/working-with-commits/squash/ GitKraken manual], squashing is available for commits that meet the following requirements:
* You need to select at least two commits to squash.
* The youngest commit, by commit date, is also the current HEAD commit.
* Genealogically consecutive.
* Chronologically consecutive.
* The oldest commit in the list has a parent.

If all these conditions are met, the '''Squash''' option appears when you right click the commit node. See [https://support.gitkraken.com/img/documentation/working-with-files/commits/squash.gif Squash.gif]

<span id="Following_other_FreeCAD_repositories"></span>
== Anderen FreeCAD Repositorien folgen ==

You can use GitKraken to follow the personal FreeCAD forks of other developers; in this way you can see how they write code and commit changes to their own branches before they submit pull requests to the upstream {{incode|FreeCAD/FreeCAD}} repository.
# In the left side panel next to the '''Remote''' category, press the '''+''' sign.
# A dialogue will come up to enter the name of the repository that you want to add. Recommended remotes are from the main FreeCAD developers and known contributors: wmayer, yorikvanhavre, ickby, sliptonic, kkremitzki, etc.
# Press '''Add Remote'''.

Now whenever new commits are made, or branches are rebased, by the authors of those repositories, you will see their commit history in a graphical way.
[[File:Gitkraken-add-remote.gif]]

<span id="Related"></span>
== Verwandtes ==

* [[Source code management/de]]
* [[Developing FreeCAD with KDevelop/de]]

[[Category:Developer Documentation{{#translation:}}]]
[[Category:Developer{{#translation:}}]]
[[Category:3rd Party{{#translation:}}]]
{{Userdocnavi}}