From 728a1df278f1864c89413f373fb4e1a4eab0d224 Mon Sep 17 00:00:00 2001 From: Harry Saunders <33317174+hsaunders1904@users.noreply.github.com> Date: Thu, 29 May 2025 13:45:34 +0100 Subject: [PATCH 1/4] Fix out of date git upstream URLs --- learners/common-issues.md | 2 +- slides/section_4_collaborative_soft_dev.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/learners/common-issues.md b/learners/common-issues.md index 09e5f5ac..4212b6fb 100644 --- a/learners/common-issues.md +++ b/learners/common-issues.md @@ -143,7 +143,7 @@ Git Bash uses its own SSH library by default, which may result in errors such as even after adding your SSH key correctly: ``` -$ git clone git@github.com:ukaea-rse-training/python-intermediate-inflammation +$ git clone git@github.com:carpentries-incubator/python-intermediate-inflammation.git Cloning into 'python-intermediate-inflammation'... git@github.com: Permission denied (publickey). fatal: Could not read from remote repository. diff --git a/slides/section_4_collaborative_soft_dev.md b/slides/section_4_collaborative_soft_dev.md index a4e0a046..5423f8f1 100644 --- a/slides/section_4_collaborative_soft_dev.md +++ b/slides/section_4_collaborative_soft_dev.md @@ -46,7 +46,7 @@ git branch --all If not, please run these commands: ```bash -git remote add upstream git@github.com:ukaea-rse-training/python-intermediate-inflammation.git +git remote add upstream git@github.com:carpentries-incubator/python-intermediate-inflammation.git git fetch upstream git checkout upstream/feature-std-dev git switch --create feature-std-dev From 8f568c824345a14bf89f40714a21fe548b0683e8 Mon Sep 17 00:00:00 2001 From: Harry Saunders <33317174+hsaunders1904@users.noreply.github.com> Date: Thu, 29 May 2025 13:46:00 +0100 Subject: [PATCH 2/4] Fix typos 'reusablility' -> 'reusability' --- slides/section_4_collaborative_soft_dev.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/slides/section_4_collaborative_soft_dev.md b/slides/section_4_collaborative_soft_dev.md index 5423f8f1..67e9dbbc 100644 --- a/slides/section_4_collaborative_soft_dev.md +++ b/slides/section_4_collaborative_soft_dev.md @@ -23,7 +23,7 @@ jupyter: - up until this point, the course has been primarily focussed on technical practices, tools, and infrastructure, and primarily from the perspective of a single developer/researcher, albeit within a team environment - in this section, we are going to start broadening our attention to the collaborative side of software development - there are primarily two practices that facilitate collaboration: code review and package release -- code review has many benefits, but top among them is that it provides a gate check on software quality, +- code review has many benefits, but top among them is that it provides a gate check on software quality, - it is also a way to share knowledge within a team, improving the redundancy of that team (which is actually a good thing regardless of what corporate types might say!) - getting another set of eyes on your code also means you are less likely to flout coding standards and convention - there are many different types of code review, and we will explore the most common in this section @@ -204,12 +204,12 @@ Follow the instructions under this exercise heading. Read the content above the -- 🔁 We want our code to be somewhere on the "reusablility" spectrum +- 🔁 We want our code to be somewhere on the "reusability" spectrum - 📝 Documentation is an important part of our code being reusable -- We want our code to be somewhere on the "reusablility" spectrum +- We want our code to be somewhere on the "reusability" spectrum - but where exactly? this will depend on the maturity of your code and how widely it will be used (similar to testing) - at a minimum, we want to aim for reproducibility if we are publishing: someone else should be able to take our code and data and run it themselves and get the same result - however, for big library packages, we probably want to bump that up to reusable, where our code is easy to use, understand, and modify @@ -217,7 +217,7 @@ Follow the instructions under this exercise heading. Read the content above the - Even if you write incredibly expressive code, it will not be enough for someone new to start using and modifying your code base - How do they install it? Are there any development tools they need? What is the scientific context and limitations of the code? - We need to answer all of these questions and more if we want our code to be approachable and reusable - + TODO would be nice to modify the image from so that it better reflects the ACM definition of reproducibility/replicability From b3aea547ab9477478965b5550b38c26d4f31b121 Mon Sep 17 00:00:00 2001 From: Harry Saunders <33317174+hsaunders1904@users.noreply.github.com> Date: Thu, 29 May 2025 13:47:59 +0100 Subject: [PATCH 3/4] Remove section 3 slide: 'Merging the Feature In' The first task in section 4 is a code review exercise, which instructs the students to open a pull request on GitHub. However, this slide at the end of section 3 instructs the students to merge their changes into develop locally. This caused some confusion last time I ran this, as the students had no existing changes to make a pull request from! --- slides/section_3_software_dev_process.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/slides/section_3_software_dev_process.md b/slides/section_3_software_dev_process.md index 2ee81f1f..694c2cbf 100644 --- a/slides/section_3_software_dev_process.md +++ b/slides/section_3_software_dev_process.md @@ -855,20 +855,6 @@ Time: 10min - -### Merge the Feature In - -Hopefully you have now refactored the feature to conform to our MVC structure, and ran our regression tests to check that the outputs rermain the same. - -We can commit this to our branch, and then switch to the `develop` branch and merge it in. - -```bash -$ git switch develop -$ git merge full-data-analysis -``` - - - ### Controller Structure From 6eef57871604f7505e621413dc90f5ebd3e0fefa Mon Sep 17 00:00:00 2001 From: bielsnohr <6177028+bielsnohr@users.noreply.github.com> Date: Fri, 30 May 2025 17:14:54 +0100 Subject: [PATCH 4/4] Revert "Remove section 3 slide: 'Merging the Feature In'" This reverts commit b3aea547ab9477478965b5550b38c26d4f31b121. --- slides/section_3_software_dev_process.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/slides/section_3_software_dev_process.md b/slides/section_3_software_dev_process.md index 694c2cbf..2ee81f1f 100644 --- a/slides/section_3_software_dev_process.md +++ b/slides/section_3_software_dev_process.md @@ -855,6 +855,20 @@ Time: 10min + +### Merge the Feature In + +Hopefully you have now refactored the feature to conform to our MVC structure, and ran our regression tests to check that the outputs rermain the same. + +We can commit this to our branch, and then switch to the `develop` branch and merge it in. + +```bash +$ git switch develop +$ git merge full-data-analysis +``` + + + ### Controller Structure