Pathway
For those building the craft of contributing: code, issues, and docs, plus testing, packaging, and reproducible workflows.
This lesson teaches how to write effective software documentation, including API documentation, user guides, and installation instructions.
Prerequisites
Best Practices for MaintainersThis lesson covers the basics of issue tracking for software projects, including how to create, manage, and close issues on GitHub.
Prerequisites
Best Practices for MaintainersThis lesson explains how to use Git for collaborative software development, focusing on advanced Git techniques such as branching, merging, and conflict resolution.
Prerequisites
Introduction to GitA comprehensive reference guide covering collaboration practices in open research — community setup, GitHub workflows, code review, meetings and events, leadership, and research infrastructure roles. Part of The Turing Way open handbook.
Prerequisites
Introduction to GitThis workshop will provide you with the basics for writing your own packages in R.
Prerequisites
Introduction to GitThis lesson teaches how to create and publish packages in Python. We assume a basic understanding of Python, and assume learners are comfortable using simple commands in a Bash shell.
Prerequisites
Collaborative Git for TeamsThis lesson teaches the essential steps for packaging Python projects and publishing them on PyPI.
Prerequisites
Modular Programming with PythonThis lesson covers best practices for building Python packages, focusing on scientific software. It explains how to structure packages, write tests, manage dependencies, and distribute packages via PyPI.
Prerequisites
Python Packaging for BeginnersThis short course is teaching tools and practices for producing and sharing quality, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software to support open and reproducible research. The course can be delivered over 2 full or 4 half days.
Prerequisites
Introduction to GitThis lesson covers how to set up continuous integration and continuous delivery pipelines for automated testing and deployment in software projects.
Prerequisites
Testing and Test-Driven DevelopmentThis lesson covers the implementation of CI/CD pipelines in research software projects, focusing on automating tests, builds, and deployments using GitLab CI.
Prerequisites
Unit Testing and TDD in PythonThis lesson covers how to write and run unit tests in Python, including an introduction to test-driven development (TDD) and its benefits.
Prerequisites
Modular Programming with PythonThis course aims to teach a core set of established, intermediate-level software development skills and best practices for working as part of a team in a research environment using Python as an example programming language (see detailed learning objectives below).
Prerequisites
Modular Programming with PythonThis lesson covers how to write tests for your code, understand test-driven development, and use testing frameworks like pytest in Python.
Prerequisites
Introduction to GitThis lesson covers the fundamentals of Docker, including creating containers, managing Docker images, and using Docker for software reproducibility and deployment.
This session aims to introduce the use of Docker containers with the goal of using them to effect reproducible computational environments. Such environments are useful for ensuring reproducible research outputs, for example.
Prerequisites
Introduction to Docker and PodmanPractical, low-barrier approaches to making research software citable, discoverable, and reusable — including CITATION.cff, licensing, metadata, and FAIR principles.
A set of practical computing habits every researcher can adopt — covering data management, code organization, collaboration, version control, and project structure.
A comprehensive reference guide covering all aspects of reproducible research — version control, testing, data management, CI/CD, open research, licensing, and more. Part of The Turing Way open handbook.
Prerequisites
Introduction to GitThis course provides an overview of key skills for Research Software Engineers, including software design, version control with Git, testing with pytest, and project management.
Prerequisites
Modular Programming with PythonThis lesson covers modular programming in Python, explaining how to write reusable code in modules, organize codebases, and test them to improve collaboration and maintainability.
Prerequisites
Introduction to Git