From 6e11ab71250e43c0c36a893f98a8a9b3b2f4ee92 Mon Sep 17 00:00:00 2001 From: Alex Lyttle <43786145+alexlyttle@users.noreply.github.com> Date: Mon, 28 Apr 2025 10:44:25 +0100 Subject: [PATCH 1/2] Update README.md with reset to tag instructions --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4dd096cb8..3759c65f2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,28 @@ # Introduction -This is a template software project repository used by the [Intermediate Research Software Development Skills In Python](https://github.com/carpentries-incubator/python-intermediate-development). +This is an exemplar repository made by following the University of Birmingham flavour of the [Intermediate Research Software Development Skills In Python](https://github.com/bham-carpentries/python-intermediate-development) course. +It is based on the [Python Intermediate Inflammation](https://github.com/carpentries-incubator/python-intermediate-inflammation) template repository provided for the course. It also provides [tags](https://github.com/bham-carpentries/python-intermediate-inflammation/tags) for the repository at the end of each section. ## Purpose -This repository is intended to be used as a code template which is copied by learners at [Intermediate Research Software Development Skills In Python](https://github.com/carpentries-incubator/python-intermediate-development) course. +This repository is intended to be used as a reference or starting point for learners who have missed a particular section of the course. +Presently, the `main` branch represents the state of the repository at the end of section 3. +Fork this repository if you wish to continue from a particular section (see below). This software project is not finished, does not contain a LICENCE file, the code is currently failing to run and contains some code style issues. It is used as a starting point for the course - issues will be fixed and code will be added in a number of places during the course by learners in their own copies of the repository, as course topics are introduced. +### Reset to the end of a section + +This repository provides tags for its state at the end of a given course section. These can be used to continue the course from a particular point. +For example, to continue from the end of section 1, reset your fork of this repository: + +```bash +git switch main # make sure you are on the main branch +git reset --hard section-1 +git push origin main --force # force push the reset main branch +``` + ## Tests Several tests have been implemented already, some of which are currently failing. From dc93cdd9467a82cfcdc237314a1ea0d7e567d342 Mon Sep 17 00:00:00 2001 From: Alex Lyttle <43786145+alexlyttle@users.noreply.github.com> Date: Mon, 28 Apr 2025 10:54:56 +0100 Subject: [PATCH 2/2] Add note on forking repository --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3759c65f2..545b859d3 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,9 @@ This repository is intended to be used as a reference or starting point for lear Presently, the `main` branch represents the state of the repository at the end of section 3. Fork this repository if you wish to continue from a particular section (see below). +> [!IMPORTANT] +> When forking this repository, remember to **uncheck** the box which says to copy the `main` branch only. + This software project is not finished, does not contain a LICENCE file, the code is currently failing to run and contains some code style issues. It is used as a starting point for the course - issues will be fixed and code will be added in a number of places during the course by learners in their own copies of the repository, as course topics are introduced.