Difference between revisions of "Mitk & Git"
MarcoNolden (talk | contribs) |
|||
(14 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | + | The current MITK source code can be viewed with the Phabricator web interface [https://phabricator.mitk.org/diffusion/MITK/ here]. | |
− | The | + | The URL for cloning MITK is |
+ | |||
+ | <code><nowiki>https://phabricator.mitk.org/source/mitk.git</nowiki></code> | ||
− | + | For client downloads and more information please visit the [http://git-scm.com/ Git] homepage. | |
− | |||
== Branches == | == Branches == | ||
− | We follow a branchy workflow. All developments are made in branches that are named after a | + | We follow a branchy workflow. All developments are made in branches that are named after a task in [https://phabricator.mitk.org/maniphest Phabricator Maniphest]. The master branch only contains merge commits. |
+ | |||
== Tags == | == Tags == | ||
Line 18: | Line 20: | ||
Tags named "releases/snapshot-YYYYMMDD" are usually created for projects using MITK which need to permanently mark a specific version of MITK. Please be aware that these releases are not always fully tested since most projects only use parts of MITK. | Tags named "releases/snapshot-YYYYMMDD" are usually created for projects using MITK which need to permanently mark a specific version of MITK. Please be aware that these releases are not always fully tested since most projects only use parts of MITK. | ||
− | |||
− | + | == Hooks == | |
+ | |||
+ | We follow some coding guidelines in the creation of MITK. These are checked for on the server side, when any changes are pushed to the server repository. If you want to contribute to MITK and make sure that your code is compliant to these guidelines you can install a git hook, which will check for several things on committing. | ||
+ | |||
+ | Install by copying [[File:pre-commit.sample|pre-commit]] to your MITK /.git/hooks/ directory. The file name has to be 'pre-commit' and the file needs to have executable permissions. | ||
+ | |||
+ | [[Category:Development]] |
Latest revision as of 11:29, 21 November 2016
The current MITK source code can be viewed with the Phabricator web interface here.
The URL for cloning MITK is
https://phabricator.mitk.org/source/mitk.git
For client downloads and more information please visit the Git homepage.
Branches
We follow a branchy workflow. All developments are made in branches that are named after a task in Phabricator Maniphest. The master branch only contains merge commits.
Tags
Tags starting with "v" are official MITK releases.
Tags named "releases/snapshot-YYYYMMDD" are usually created for projects using MITK which need to permanently mark a specific version of MITK. Please be aware that these releases are not always fully tested since most projects only use parts of MITK.
Hooks
We follow some coding guidelines in the creation of MITK. These are checked for on the server side, when any changes are pushed to the server repository. If you want to contribute to MITK and make sure that your code is compliant to these guidelines you can install a git hook, which will check for several things on committing.
Install by copying File:Pre-commit.sample to your MITK /.git/hooks/ directory. The file name has to be 'pre-commit' and the file needs to have executable permissions.