swcarpentry / git-novice

Version Control with Git

Home Page:http://swcarpentry.github.io/git-novice/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Replace Dracula example-project with more realistic project

aghr opened this issue · comments

Dear All,

One idea to improve the Git Novice lesson is to switch from the Dracula example-repo to a more realistic example, eg. one connected to coding in Python for example. One key advantage I see here is that students along learning Git would get a bit of experience right away in topics like creating a README.md possibly with a tiny bit of Markdown experience, which is often essential for making public their repos on GitHub, and adding a file LICENSE to the repo. The last would smoothly prepare the students a bit for the later section on Licensing and the first for the section on Open Science. I imagine that many course participants in higher education (Master/PhD students, PostDocs, PIs) probably will more likely use Git for tracking coding projects than for any other kind of project.

One big reason this lesson doesn't use coding is it will create cognitive overload, and learners will focus on learning coding or markdown instead of git. There is an open issue which discusses this, as well as alternatives to the current story.