Skip to content

Commit 8741331

Browse files
committed
differences for PR #462
1 parent bb876d6 commit 8741331

6 files changed

Lines changed: 16 additions & 28 deletions

14-collaboration-using-git.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,10 +624,12 @@ which is often the source branch for website projects hosted on GitHub
624624

625625
::::::::::::::::::::::::::::::::::::::::::::::::::
626626

627-
::::::::::::::::::::::::::::::::::::::::: callout
627+
::::::::::::::::::::::::::::::::::::: testimonial
628628

629629
## Keeping Main Branch Stable
630630

631+
::::::::::::::::::::::::::::::::::::::::::::::::::
632+
631633
Good software development practice is to keep the `main` branch stable
632634
while you and the team develop and test new functionalities on feature branches
633635
(which can be done in parallel and independently by different team members).
@@ -637,7 +639,7 @@ work well with the rest of the code (and not just in isolation).
637639
We talk more about different types of code testing in one of the following episodes.
638640

639641

640-
::::::::::::::::::::::::::::::::::::::::::::::::::
642+
641643

642644
:::::::::::::::::::::::::::::::::::::::: keypoints
643645

23-continuous-integration-automated-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ first_scaled_by:
131131
date_of_birth: 1858-03-22
132132
nationality: German
133133
- name: Ludwig Purtscheller
134-
date_of_birth: 1849-10-06
134+
date_of_birth: 1858-03-22
135135
nationality: Austrian
136136
```
137137

common-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Git Bash uses its own SSH library by default, which may result in errors such as
143143
even after adding your SSH key correctly:
144144

145145
```
146-
$ git clone git@github.com:ukaea-rse-training/python-intermediate-inflammation
146+
$ git clone git@github.com:carpentries-incubator/python-intermediate-inflammation.git
147147
Cloning into 'python-intermediate-inflammation'...
148148
git@github.com: Permission denied (publickey).
149149
fatal: Could not read from remote repository.

md5sum.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@
1111
"episodes/11-software-project.md" "f5e403d2b25781407eaed7534dfff9ec" "site/built/11-software-project.md" "2024-12-06"
1212
"episodes/12-virtual-environments.md" "bc4f97c27cf5f63646f4be54f6c492d8" "site/built/12-virtual-environments.md" "2025-04-01"
1313
"episodes/13-ides.md" "5a1badf094a9022c001bdbdbf7ceedfa" "site/built/13-ides.md" "2025-03-07"
14-
"episodes/14-collaboration-using-git.md" "8c21ee633bb44148b868504302e129ab" "site/built/14-collaboration-using-git.md" "2025-05-30"
14+
"episodes/14-collaboration-using-git.md" "765379f4c22b5a5bd7449f400d8cc140" "site/built/14-collaboration-using-git.md" "2025-05-30"
1515
"episodes/15-coding-conventions.md" "edeb54ce0ada9fb1a6ae4b38ea391a63" "site/built/15-coding-conventions.md" "2025-04-01"
1616
"episodes/16-verifying-code-style-linters.md" "0cb677e60bb505b78e523617f49f33de" "site/built/16-verifying-code-style-linters.md" "2025-03-07"
1717
"episodes/17-section1-optional-exercises.md" "e41c7fe74d6067e4101908deb100162b" "site/built/17-section1-optional-exercises.md" "2025-04-01"
1818
"episodes/20-section2-intro.md" "de5af08b90601de19c724a0c9d7c3082" "site/built/20-section2-intro.md" "2024-12-06"
1919
"episodes/21-automatically-testing-software.md" "ea242bf1a65757da67bb2237fb522445" "site/built/21-automatically-testing-software.md" "2025-04-01"
2020
"episodes/22-scaling-up-unit-testing.md" "049c86638afb5e99590dbf04a3f92f61" "site/built/22-scaling-up-unit-testing.md" "2025-03-07"
21-
"episodes/23-continuous-integration-automated-testing.md" "a0ad567113da722f4c5ad8ab4c34b0d1" "site/built/23-continuous-integration-automated-testing.md" "2025-05-30"
21+
"episodes/23-continuous-integration-automated-testing.md" "3345e68ba82b2ff28da1f99d3e05e7a9" "site/built/23-continuous-integration-automated-testing.md" "2025-05-30"
2222
"episodes/24-diagnosing-issues-improving-robustness.md" "32ac0fb6b1d419f5bc63c98d5acb2ab3" "site/built/24-diagnosing-issues-improving-robustness.md" "2025-05-27"
2323
"episodes/25-section2-optional-exercises.md" "439682a4955568fa290b79ab2b486797" "site/built/25-section2-optional-exercises.md" "2024-12-06"
2424
"episodes/30-section3-intro.md" "24e70667c1848061ecb3d42ecf17dbf8" "site/built/30-section3-intro.md" "2024-12-06"
@@ -39,7 +39,7 @@
3939
"instructors/instructor-notes.md" "0145a4d0e4df14ce1d4f08ecaa171515" "site/built/instructor-notes.md" "2024-12-06"
4040
"learners/quiz.md" "bd60170ec9f07bc2d510f55353179217" "site/built/quiz.md" "2024-12-06"
4141
"learners/installation-instructions.md" "516ae49d52941813dae9d2ed82bd6127" "site/built/installation-instructions.md" "2024-12-06"
42-
"learners/common-issues.md" "8365733ad45b543bae6a4e523b6f88aa" "site/built/common-issues.md" "2025-04-01"
42+
"learners/common-issues.md" "4661f811bdea175eda7b77ae2a7cc605" "site/built/common-issues.md" "2025-05-30"
4343
"learners/software-architecture-extra.md" "75cca9330b84bddf8223944131639f4f" "site/built/software-architecture-extra.md" "2024-12-06"
4444
"learners/programming-paradigms.md" "2c3cdee71c1c975c0cf99260493b6e67" "site/built/programming-paradigms.md" "2024-12-06"
4545
"learners/procedural-programming.md" "ede81ccae989c46e47af0417ac31b401" "site/built/procedural-programming.md" "2024-12-06"
@@ -53,6 +53,6 @@
5353
"profiles/learner-profiles.md" "60b93493cf1da06dfd63255d73854461" "site/built/learner-profiles.md" "2024-12-06"
5454
"slides/section_1_setting_up_environment.md" "65631efd5db06ee9335f3ef026bdab72" "site/built/section_1_setting_up_environment.md" "2025-05-27"
5555
"slides/section_2_ensuring_correctness.md" "9ff6a044969f7959e32ffd1d9c60edd8" "site/built/section_2_ensuring_correctness.md" "2025-05-27"
56-
"slides/section_3_software_dev_process.md" "2f273ac5d34158dfc0cd0e98c8308c82" "site/built/section_3_software_dev_process.md" "2025-05-27"
57-
"slides/section_4_collaborative_soft_dev.md" "1a525b52fc0b08d2abd669411df544d5" "site/built/section_4_collaborative_soft_dev.md" "2025-05-27"
56+
"slides/section_3_software_dev_process.md" "db2f3277be9cd6c0c4da7eed4ff900ce" "site/built/section_3_software_dev_process.md" "2025-05-30"
57+
"slides/section_4_collaborative_soft_dev.md" "e99956f241d3fe9c9c38f37c2cb40ff6" "site/built/section_4_collaborative_soft_dev.md" "2025-05-30"
5858
"slides/section_5_managing_software.md" "378f9bc03723cc1113cc4766df35186d" "site/built/section_5_managing_software.md" "2025-05-27"

section_3_software_dev_process.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -855,20 +855,6 @@ Time: 10min
855855

856856
<!-- #endregion -->
857857

858-
<!-- #region slideshow={"slide_type": "subslide"} editable=true -->
859-
### Merge the Feature In
860-
861-
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.
862-
863-
We can commit this to our branch, and then switch to the `develop` branch and merge it in.
864-
865-
```bash
866-
$ git switch develop
867-
$ git merge full-data-analysis
868-
```
869-
870-
<!-- #endregion -->
871-
872858
<!-- #region slideshow={"slide_type": "subslide"} editable=true -->
873859
### Controller Structure
874860

section_4_collaborative_soft_dev.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jupyter:
2323
- 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
2424
- in this section, we are going to start broadening our attention to the collaborative side of software development
2525
- there are primarily two practices that facilitate collaboration: code review and package release
26-
- code review has many benefits, but top among them is that it provides a gate check on software quality,
26+
- code review has many benefits, but top among them is that it provides a gate check on software quality,
2727
- 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!)
2828
- getting another set of eyes on your code also means you are less likely to flout coding standards and convention
2929
- there are many different types of code review, and we will explore the most common in this section
@@ -46,7 +46,7 @@ git branch --all
4646
If not, please run these commands:
4747

4848
```bash
49-
git remote add upstream git@github.com:ukaea-rse-training/python-intermediate-inflammation.git
49+
git remote add upstream git@github.com:carpentries-incubator/python-intermediate-inflammation.git
5050
git fetch upstream
5151
git checkout upstream/feature-std-dev
5252
git switch --create feature-std-dev
@@ -204,20 +204,20 @@ Follow the instructions under this exercise heading. Read the content above the
204204
<!-- #endregion -->
205205

206206
<!-- #region slideshow={"slide_type": "subslide"} -->
207-
- 🔁 We want our code to be somewhere on the "reusablility" spectrum
207+
- 🔁 We want our code to be somewhere on the "reusability" spectrum
208208
- 📝 Documentation is an important part of our code being reusable
209209
<!-- #endregion -->
210210

211211
<!-- #region slideshow={"slide_type": "notes"} -->
212-
- We want our code to be somewhere on the "reusablility" spectrum
212+
- We want our code to be somewhere on the "reusability" spectrum
213213
- but where exactly? this will depend on the maturity of your code and how widely it will be used (similar to testing)
214214
- 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
215215
- however, for big library packages, we probably want to bump that up to reusable, where our code is easy to use, understand, and modify
216216
- Documentation is an important part of our code being reusable
217217
- Even if you write incredibly expressive code, it will not be enough for someone new to start using and modifying your code base
218218
- How do they install it? Are there any development tools they need? What is the scientific context and limitations of the code?
219219
- We need to answer all of these questions and more if we want our code to be approachable and reusable
220-
220+
221221
TODO would be nice to modify the image from <https://the-turing-way.netlify.app/_images/reproducible-definition-grid.svg> so that it better reflects the ACM definition of reproducibility/replicability
222222
<!-- #endregion -->
223223

0 commit comments

Comments
 (0)