From e3973d0b760e9d476cc9282ae56946ac3bbd2dfd Mon Sep 17 00:00:00 2001 From: DaniBodor Date: Mon, 30 Sep 2024 15:02:47 +0200 Subject: [PATCH] vc exercise --- modules/version-control/version_control_exercise.md | 13 +++++++++++++ .../version-control/version_control_exercise1.md | 12 ------------ .../version-control/version_control_exercise2.md | 10 ---------- 3 files changed, 13 insertions(+), 22 deletions(-) create mode 100644 modules/version-control/version_control_exercise.md delete mode 100644 modules/version-control/version_control_exercise1.md delete mode 100644 modules/version-control/version_control_exercise2.md diff --git a/modules/version-control/version_control_exercise.md b/modules/version-control/version_control_exercise.md new file mode 100644 index 00000000..d78d15d1 --- /dev/null +++ b/modules/version-control/version_control_exercise.md @@ -0,0 +1,13 @@ +--- +title: What to include in the repository +type: exercise +order: 3 +--- + +## Exercise: Which of the following do you think should be part of a code repository (5-10 mins) + +- installation instructions +- user documentation +- full dataset to reproduce figures from a paper +- a few data files to test the functionality of the code base +- in-line comments intended only for code developers diff --git a/modules/version-control/version_control_exercise1.md b/modules/version-control/version_control_exercise1.md deleted file mode 100644 index b6b48a2b..00000000 --- a/modules/version-control/version_control_exercise1.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Case Study -type: exercise -order: 3 ---- - -## Exercise: Case Study - -**Case study**: A researcher comes to you with a problem of how to keep track of different versions of code. - -What advice would you give the researcher to keep track of changes of their scripts/code and when best to do this. -Would you advise them to work with a local or remote version control system? \ No newline at end of file diff --git a/modules/version-control/version_control_exercise2.md b/modules/version-control/version_control_exercise2.md deleted file mode 100644 index 5c48823e..00000000 --- a/modules/version-control/version_control_exercise2.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Tool search -type: exercise -order: 4 ---- - -## Exercise: tool search - -In breakout groups of 3-4 people, identify 3 commonly used version control systems or tools that you have heard of (or used yourself) (for example: Git). -Together, search for a resource (such a website, or handbook) for each tool that helps explain how to use its key features. \ No newline at end of file