List of exercises

We provide this list below to make it easier for team leaders to prepare and navigate lesson material. We often change the material before each workshop and in this page we list also any ongoing or planned changes to avoid surprises.

Day 1 (Introduction to version control with Git)

• Recording changes (20 min).
  • Record changes
  • Optional exercises
• Optional exercises (20 min).
  • One or all optional exercises
• Branching and merging (20 min).
  • Branch-1
  • Branch-2
  • There are also optional exercises

Day 2 (Introduction to version control with Git)

• Pushing to GitHub (20 min).
  • Set up SSH keys
  • Pushing our guacamole recipe repository to GitHub
  • Clone repository
• Inspecting history (30 min).
  • History-1
  • History-2 is optional
• Undoing and recovering (25 min). We let participants/groups choose among:
  • Undoing-1
  • Undoing-2
  • Undoing-3

Day 3 (Collaborative distributed version control)

• Create a pull request (30 min). Creating a branch and commit, pushing the branch, creating a pull request, and reviewing pull requests.
• Working with forks (30 min).

Day 4 (Reproducible research and Social coding and open software)

• Workflow-1 and Workflow-2 (25 min).
• Containers-1 (20 min).
• Rest is collaborative "discussion" in collaborative document and demo.
• Episode "Sharing code and data" will move to the "Social coding and open software" lesson.
• No individual/group exercise in the "Social coding and open software" part. We will all participate via collaborative document. Nothing to prepare for team leaders.

Day 5 (How to document your research software and Jupyter notebooks)

• Writing good README files (20 min).
  • README-1 or README-2 or README-3
• Sphinx and Markdown and Deploying Sphinx documentation to GitHub Pages (20 min).
  • Sphinx-2
  • Sphinx-3 (optional)
  • GH-Pages-1
• First computational notebook (20 min).
• Sharing a notebook using Binder (20 min).

Day 6 (Automated testing and Modular code development)

• Testing locally (20 min).
• Test design (20 min). We will add an end-to-end test exercise here as option.
• No individual/group exercise in the "Modular code development" part. Learners will participate all via collaborative document and ask and advice instructors.