Merge pull request #13 from pythonhealthdatascience/dev

Dev

Author: amyheather

CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Dates formatted as YYYY-MM-DD as per [ISO standard](https://www.iso.org/iso-8601-date-and-time-format.html).
+
+## v0.1.0 - 2026-01-20
+
+🌱 Initial release of the website.
+
+### Added
+
+* Website with pages:
+    * Homepage
+    * When and why to run tests
+    * Case study
+    * How to write a basic test
+    * How to run tests
+    * Parametrising tests
+    * Unit tests
+    * Functional tests
+    * Back tests
+    * What was the point? Let's break it and see!
+    * Test coverage
+    * Running tests via GitHub actions
+    * Example repositories
+* Python and R environments for the site.
+* GitHub actions to create docker, render and deploy site, and run python and R tests.
+* Example python and R code used within website in `examples/`.
+* Other research artefacts (e.g., `tools/`, `CONTRIBUTING.md`, `README.md`).

CITATION.cff

@@ -0,0 +1,32 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: 'HDR UK Futures RSE: Testing in Research Workflows'
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Amy
+    family-names: Heather
+    email: a.heather2@exeter.ac.uk
+    affiliation: University of Exeter
+    orcid: 'https://orcid.org/0000-0002-6596-3479'
+  - given-names: Tom
+    family-names: Monks
+    email: t.m.w.monks@exeter.ac.uk
+    affiliation: University of Exeter
+    orcid: 'https://orcid.org/0000-0003-2631-4481'
+repository-code: 'https://github.com/pythonhealthdatascience/hdruk_tests/'
+url: 'https://pythonhealthdatascience.github.io/hdruk_tests/'
+abstract: >-
+  Materials supporting our HDR UK Futures training videos on
+  testing.
+keywords:
+  - tests
+  - python
+  - r
+license: MIT
+version: 0.1.0
+date-released: '2026-01-20'

README.md

@@ -6,4 +6,19 @@ You can view the website here: <https://pythonhealthdatascience.github.io/hdruk_
 
 [![](images/website_screenshot.png)](https://pythonhealthdatascience.github.io/hdruk_tests/)
 
-For an explanation of how this site is set up and quality-controlled, please see `CONTRIBUTING.md`.
+For an explanation of how this site is set up and quality-controlled, please see `CONTRIBUTING.md`.
+
+## Licence
+
+This work is shared:
+
+* Code licence - MIT
+* Text licence - CC-BY-SA 4.0
+
+## Citation
+
+To cite this work, see the `CITATION.cff` file in this repository or use the "Cite this repository" button on GitHub.
+
+## Funding
+
+This project is supported by the Medical Research Council [grant number MR/Z503915/1].

images/run_tests_r_githubactions.png

@@ -262,6 +262,17 @@ The tests all pass in the end-
 
 ::: {.r-content}
 
-TODO
+* Open the [GitHub repository](https://github.com/pythonhealthdatascience/hdruk_tests).
+* Go to the [Actions](https://github.com/pythonhealthdatascience/hdruk_tests/actions) tab.
+* Click on the [r_tests](https://github.com/pythonhealthdatascience/hdruk_tests/actions/workflows/r_tests.yaml) action.
+* View the [workflow YAML](https://github.com/pythonhealthdatascience/hdruk_tests/blob/main/.github/workflows/r_tests.yaml).
+* Trigger the action via `workflow_dispatch`, running it from the `dev` branch.
+* [View the running test](https://github.com/pythonhealthdatascience/hdruk_tests/actions/runs/21166564091) - see they are installing the packages, getting ready to run tests.
+
+{{< video /videos/run_tests_r_githubactions.webm >}}
+
+The tests all pass in the end-
+
+![](/images/run_tests_r_githubactions.png)
 
 :::