The aim of this repo is for participants to understand how to contribute to an open source project.
I have also included instructions on how to configure the repo to behave like an open source repo if you want to read them later.
- Fork this repo to your personal GitHub user account. See GitHub instructions. Forking the main branch only is generally a good idea, so accept the default.
- Clone the forked repo onto your PC.
- Take a look at the files in this repo. You'll notice the file
CONTRIBUTING.md. Take a look at the contents to see what a real open source project might require of you. You can ignore all of this stuff for this exercise. - THIS IS IMPORTANT: Do not push any changes to the main branch. Whilst GitHub will convert any changes you make into a PR, it becomes impossible to synchronise with the maintainer's repo. This can be a pain.
- Create a new branch (or switch to the one from above if you created it).
- Fix the deliberate typos in
fix-me.md. - Commit the changes.
- Add a couple of lines of text to the new section, including your name somewhere.
- Commit the changes.
- Push the branch to your repo.
Stop here and tell Andy that you are ready to create your PR.
© 2026, University of Leeds.
The author, A. Blight, has asserted his moral rights.