Refinements following initial feedback; add AI tooling

Author: jsbrittain

img/linter.png

@@ -92,6 +92,7 @@ class: "gap-4"
 - Cost-effective error removal
 - Enhances team learning and collaboration
 - Improves overall team software development process
+- Increasingly, AI 'reviewers' are able to check your code for common issues, _but_ human review is still essential to provide context and understanding
 
 ::right::
 

img/numpy-versions.png

@@ -142,22 +142,6 @@ layout: instruction
 
 ::left::
 
-<div class="text-sm">
-<i>Example:</i>
-</div>
-
-<div class="text-sm w-full max-w-[80%] mx-auto leading-none table-tight">
-
-| | ubuntu | windows | macos |
-|--|:--:|:--:|:--:|
-| python 3.9 | ❌ | ❌ | ❌ |
-| python 3.10 | ✅ | ❌ | ✅ |
-| python 3.11 | ✅ | ❌ | ✅ |
-| python 3.12 | ✅ | ❌ | ✅ |
-
-<div class="h-5" />
-
-</div>
 
 ```yaml
 jobs:
@@ -166,22 +150,39 @@ jobs:
     strategy:
         matrix:
             os: [ubuntu-latest, windows-latest, macos-latest]
-            python-version: [3.9, 3.10, 3.11, 3.12]
+            python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
 ```
 
-<div class="absolute border border-gray-400 left-85 top-90">
+and
+
 ```yaml
-on:
-  workflow_dispatch:
+    - name: Install dependencies
+      shell: bash                      # add this line
+      run: |
 ```
-</div>
 
 ::right::
 
-Task:
 - Add test matrix
-- Add `workflow_dispatch` trigger to your workflow (this allows you to run the action manually)
-- Re-run your tests
+
+_Example_
+
+<div class="text-sm w-full max-w-[80%] mx-auto leading-none table-tight">
+
+| | ubuntu | windows | macos |
+|--|:--:|:--:|:--:|
+| python 3.9 | ❌ | ❌ | ❌ |
+| python 3.10 | ✅ | ❌ | ✅ |
+| python 3.11 | ✅ | ❌ | ✅ |
+| python 3.12 | ✅ | ❌ | ✅ |
+
+</div>
 
 <!-- You now have the foundation of any Python package! -->
 

img/tdd.png

@@ -55,6 +55,12 @@ rightClass: "items-center justify-center gap-10"
 <small>(year.month)</small>
 </div>
 
+<!---
+- Explain major, minor, patch version numbers here
+- Explain calendar versioning
+- Explain why we would use one over the other
+-->
+
 ---
 layout: two-cols-header
 ---
@@ -101,16 +107,27 @@ def main():
 **numpy** is a top-20 downloaded package on PyPI<br>
 which in June 2024 released a new major version.
 
+<v-click>
+
 Numpy v1 and v2 were no longer entirely compatible.
 
+</v-click>
+
+<v-click>
+
 The official release notes included the phrase:
 
-_“This major release includes <span v-mark.circle.red="1">breaking changes</span>…<br>
-including an ABI break …<br>
-and API changes …”_
+_“This major release includes <span v-mark.circle.red="3">breaking changes</span>…<br>
+including API changes …”_
+
+</v-click>
 
 <!--
-In the example given an informative error is provided to the user. However, some changes may be more surruptitious, such as rules over type promotion (float32 may be returned instead of float64 now when mixing types in expressions).
+In the example given an informative error is provided to the user. However, some changes may be more surreptitious, such as rules over type promotion (float32 may be returned instead of float64 now when mixing types in expressions).
+
+API = Application Programming Interface, the function signature, how you interact with the library.
+
+Code written in one major may not work in another major version. How do we manage old and new codebases that rely on different versions of the same library?
 -->
 
 ::

modules/collaborative-coding.md

@@ -191,13 +191,18 @@ Create a new repository, clone and push changes
 
 ::right::
 
+::small
+
 Instructor follow-along:
 
 - Create a new repository (Github interface)
   - Add a README.md, .gitignore and select a license
-- Open the repository in Codespaces
-  - This mimics `git clone` on your local machine (see <Link to="reference-material" title="Reference material" />)
-- Add a file, stage and commit
-- Push changes to Github: `git push`
-- Explore commit history (Github interface)
-- (Optional) Practice creating and pushing a new branch
+- Open the repository in Codespaces (this mimics `git clone` on your local machine, see <Link to="reference-material" title="Reference material" />)
+  - Add a file, stage and commit
+  - Push changes to Github: `git push`
+- On the Github interface:
+  - Explore the commit history
+  - Create an Issue and assign yourself to work on it
+- (Optional) Create and push a new branch from codespaces, then switch between branches on Github
+
+::

modules/continuous-integration.md

@@ -282,39 +282,65 @@ transition: "none"
 ::center
 
 <v-click>
-<i>
 When working with a <b>legacy</b> codebase,
 <br />start with a few <b>regression tests</b> to ensure
 <br />that the output is not changing.
-</i>
 </v-click>
 
 <br />
 
 <v-click>
-<i>
 <br />Then, start adding <b>unit tests</b> for
 <br />new features or bug fixes.
-</i>
+</v-click>
+
+---
+transition: "none"
+---
+
+# Automated Testing
+
+<div class="text-gray-400">
+<b>Unit tests</b>: Test specific units of functionality, ensuring expected outputs from given inputs.
+
+<b>Integration (functional) tests</b>: Test functional paths through the code, especially useful for exposing faults in unit interactions.
+</div>
+
+<b>Regression tests</b>: Ensure unchanged program output despite code modifications.
+
+::center
+
+<br />When working with <b>AI</b>, verify the code
+<br />behaves as expected with <b>tests</b>.
+
+<v-click>
+<br />When relying heavily on AI,
+<br />allow it to write <i><b>either</b></i> code <b><i>or</i></b> some tests.
+<br />Not both - this defeats the purpose of testing!
 </v-click>
 
 ::
 
+<!--
+AI-generated tests can be trivial or miss important edge cases
+-->
+
 ---
 
 # PyTest
 
 pytest: a framework for automated testing
 - Automatically finds any function starting in `test_` or ends in `_test`
 - Produces a report indicating test status
-- Many advanced features (e.g. mocks, fixtures)
+- Many advanced features (e.g. exception testing, mocks, fixtures)
 - Install with `pip install pytest`
 - Run with `pytest` (or `pytest -v` for an itemised view)
 
 Testing investment should match the software's complexity and usage
 
 <!--
-PyTest provides a convenient report across all tests
+Rather than managing tests manually, PyTest provides a convenient package to collate
+and run tests across a codebase, producing a reports with their status.
 -->
 
 ---

modules/dependency-management.md

@@ -8,6 +8,8 @@ routeAlias: "version-control"
 
 ::left::
 
+<div class="h-5" />
+
 - *Version control* provides a full history of your project's software and other assets
 - Makes for easy:
   - Backups
@@ -36,7 +38,7 @@ routeAlias: "version-control"
 whatever else you might be doing with a computer,<br>
 it’s not science."</i><br>
 <br>
-Greg Wilson, SWC
+Greg Wilson, SWC<br/><div style="font-size: 0.8rem;"><i>First Executive Director of Software Carpentry</i></div>
 
 ::