diff --git a/2019/2019-06-11_gitTraining/slides/img/qualitybadge.png b/2019/2019-06-11_gitTraining/slides/img/qualitybadge.png new file mode 100644 index 0000000000000000000000000000000000000000..4c2aea855d8168733099d04286c9497338a8bf63 Binary files /dev/null and b/2019/2019-06-11_gitTraining/slides/img/qualitybadge.png differ diff --git a/2019/2019-06-11_gitTraining/slides/img/snoopy.png b/2019/2019-06-11_gitTraining/slides/img/snoopy.png new file mode 100644 index 0000000000000000000000000000000000000000..af89c0b75a83f3339190f67987c306e1bd171c07 Binary files /dev/null and b/2019/2019-06-11_gitTraining/slides/img/snoopy.png differ diff --git a/2019/2019-06-11_gitTraining/slides/list.json b/2019/2019-06-11_gitTraining/slides/list.json index 02a89925d24383f15735d26bd34adc04cc8f0510..e06ee227643e58157bcacd9221c2d00ceff5d03a 100644 --- a/2019/2019-06-11_gitTraining/slides/list.json +++ b/2019/2019-06-11_gitTraining/slides/list.json @@ -17,6 +17,9 @@ { "filename": "whyCare.md" }, + { + "filename": "qualityCode.md" + }, { "filename": "what_is_git.md" }, diff --git a/2019/2019-06-11_gitTraining/slides/qualityCode.md b/2019/2019-06-11_gitTraining/slides/qualityCode.md new file mode 100644 index 0000000000000000000000000000000000000000..d81e2f0d7388f491c11e0612a91f773ee6af0b17 --- /dev/null +++ b/2019/2019-06-11_gitTraining/slides/qualityCode.md @@ -0,0 +1,34 @@ +## Quality of computer code is relevant for everyone. + +`This does not concern me – I am only writing documentation or a script for generating a figure that I want to publish!` +[Anonymous researcher] + +<div class="fragment"> + +**Great**, but ... + +- Figure may not be reproducible +- Figure looks different when the input data changes +- Documentation will become outdated + +… actually, **EVERYONE** writing documentation, a script, or code is concerned! + +<div align="center"> +<img src="slides/img/snoopy.png"> +</div> + + + +## Attributes of high-quality computer code + +**Quality** of computer code can be seen as a **group of various attributes**. + +High-quality computer code should be: + +1. <font color="#A52A2A">**Versioned**</font>: incremental code +2. <font color="#FFA500">**Well-written**</font> (formatted, documented, commented): easy to read by a human +3. <font color="#008931">**Tested**</font>: extensively tested code + +<div align="center"> +<img src="slides/img/qualitybadge.png"> +</div> \ No newline at end of file