Skip to content

Diagram(s) for Introduction to Version Control course #49

@linustata

Description

@linustata

Content to be adapted

Motivation

The Introduction to Version Control course is aimed at people with no former knowledge or experience of version control. One aspect people tend to struggle with is the idea of the "staging area", and exactly what is happening at each step of the modify-add-commit cycle.

Output

A series of slides (or images that could be put on slides) to aid with the explanation given in the course. They should show the working tree, staging area, and repository. They should also show how files/changes to files move through these three areas as a user modifies, adds, and commits changes.

The resulting files should be added to the course's GitHub repository, in the folder "images". If you feel that the images fit in a particular location within the course, please feel free to add the images to the course content itself within the relevant .ipynb file.

Considerations / Notes

  • A particular detail that people can find confusing is the difference between doing git add on an untracked file vs. on a tracked file that has been modified.
  • It would be helpful (but not required) if the images could be easily edited (in particular, changing text, in case a future presenter wants to change terminology).
  • If there are existing resources we can use that would be fine - but make sure we're legally allowed to use them, and include credit in the image/slide.
  • Here are the relevant course notes, which which do already include an image at the bottom. However, it could be better for showing the "flow" of modify-add-commit, and what happens at which step.
  • The course notes on the website are aimed more at self study, and usually aren't strictly followed in delivery. It's fine if the "flow" of the diagrams requires explaining things in a different order to the course notes, if it makes sense.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions