Differences

This shows you the differences between two versions of the page.

--- tools:vcs:index [2019/01/27 20:13] – [What to use] till
+++ tools:vcs:index [2020/09/29 16:30] (current) – till
@@ Line 1: / Line 1: @@
-====== Version control ======
+~~NOTOC~~
+{{fa>code-fork?48&align=right}}
+ ====== Version control ======
 //Versioning and archiving of processing routines//
+<WRAP group>
+<WRAP column 32px>{{fa>key?32}}</WRAP>
+<WRAP column 85%>
+  * Version control has a liberating effect on software development.
+  * Version control is an essential prerequisite\\ to unequivocally identify the version of a routine employed.
+  * Distributed version control systems facilitate their use\\ and reduce external dependencies.
+  * For a larger project, a clear work flow should be established\\ and followed consequently.
+  * Version control has the largest impact on how we program --\\ besides automatic tests.
+</WRAP>
+</WRAP>
-===== What to use =====
+===== Why versioning? =====
+  * Software is //always// subject to change -- that's why it is called "soft".
+  * Routines for data processing and analysis develop, often together with the understanding of the task.
+  * Reverting to the last version that "just worked" is an (easy) task.
+===== What should be versioned? =====
+  * Basically everthing, from a script for data processing to the final manuscript/thesis/project report
+===== What are prerequisites for ubiquitious versioning? =====
+  * Open file formats allowing for easy versioning (ideally text formats)
+  * Minimal infrastructure requirements, as met by a distributed version control system
+  * Possibility to share versioned data with others (via simple-to-use web interfaces)
+Beware: Versioning without [[..:versionnumbers:|version numbers]] is only half the battle.
+===== Which tool to use =====
+Note: This section is clearly opinionated. There are definitely other tools available. However, this is the tool the author recommends from own experience.
 <WRAP group>
@@ Line 13: / Line 50: @@
 </WRAP>
+<WRAP group>
+<WRAP column 32px>[[https://www.github.com/|{{fa>github?32}}]]</WRAP>
+<WRAP column 76%>
+[[https://www.github.com/|github.com]]\\ Largest development and code-sharing online platform, with free accounts
+</WRAP>
+</WRAP>
+For local applications and given a minimum of infrastructure, [[https://gitea.io/|Gitea - Git with a cup of tea]] is highly recommended as a fast and light-weight alternative to services such as [[https://about.gitlab.com/|GitLab]]. Gitea describes itself as a "painless self-hosted Git service" -- and this really //is// true.
+\\
+<WRAP half column leftalign><WRAP button>[[..:|← Tools]]</WRAP></WRAP>
+<WRAP half column rightalign><WRAP button>[[..:versionnumbers:|Version numbers →]]</WRAP></WRAP>