List of exercises

This list is subject to changes until the week before the workshop.

Day 1:

• Copy and browse an existing project
• Committing changes
• Merging changes and contributing to the project

Day 2:

• Cloning a Git repository and working locally
• Inspecting history
• How to turn your project to a Git repo and share it

Day 3:

• Collaborating within the same repository
• Practicing code review
• How to contribute changes to repositories that belong to others

Day 4:

• Recording Computational steps - Snakemake as an exemplary workflow manager
• Environments as time capsules for dependencies
• DEMO - Using docker to run a local service without installing the software

Day 5:

• Only discussions in notes document.

Day 6:

• Demo: README Features
• Exercise session: either Improve the README for your own project or, lacking that: Discuss the README of a project that you use
• Demo: Sphinx Quickstart
• Exercise session:
  • Adding more Sphinx Content
  • Sphinx and LaTeX
  • Create documentation from code comments with Autodoc
• Demo:
  • Deploy Sphinx documentation to GitHub Pages
  • Hosting websites/homepages on GitHub Pages

Day 7:

• Exercise session: A first computational notebook
• Exercise session: Sharing dynamic notebooks on Binder

Day 8:

• Exercise session: Testing locally
• Exercise session: Test design

Day 9:

• Exercise session (we offer a discussion track and a coding track)