Skip to content

Update README.md with reset to tag instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexlyttle merged 2 commits into from
Apr 28, 2025
Merged

Update README.md with reset to tag instructions #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e11ab7
Update README.md with reset to tag instructions
alexlyttle Apr 28, 2025
dc93cdd
Add note on forking repository
alexlyttle Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,31 @@
# 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).

> [!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.

### 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.
Expand Down