Tutorial: Open Source Software for Research - Sharing Code the Right Way

Tutorial from the DDLS 2025 workshop "Open Source Software for Research – Sharing Code and Software the Right Way" on improving the FAIRness and openness of research code on GitHub.

This tutorial applies the SciLifeLab Open Software Checklist (DOI) to improve the openness of your repository.

Each point is broken down into what needs to be addressed, why it matters, and how to solve it. To make this concrete, every point has been applied to an example repository, the ook-translator. The “ook-translator” is a mock application that translates between human and orangutan language, inspired by Terry Pratchetts Discworld Librarian who only speaks in “ook” sounds (not relevant for the tutorial, don't worry).

You can find the tutorial in sharing-code-the-right-way.md.