Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion for embedding Episode 6 in storyline #773

Open
mwakok opened this issue Jan 18, 2021 · 1 comment
Open

Suggestion for embedding Episode 6 in storyline #773

mwakok opened this issue Jan 18, 2021 · 1 comment
Labels
status:need more info More information needed

Comments

@mwakok
Copy link

mwakok commented Jan 18, 2021

In the Ignoring Things episode we are creating dummy files and a directory in order to add to .gitignore. Currently, none of the material in this lesson relates to the story about Wolfman we had been following up until this point. I would like to suggest to embed this lesson in the storyline. Surely our protagonists would need to collect some data about the atmosphere on Mars that they don't want to be tracked by Git? ;)

At the very least, I believe we should relate the new files and folder to the already present directory structure. This will also ensure that we are still using the git repository we have already created. I have had some confusion arise on this before, when learners created a new folder (somewhere) that doesn't have an initialized repository.

I would like to suggest to update the first commands with (similar to Lesson 3):

cd ~/Desktop/planets
mkdir data
cd data
touch a.dat b.dat c.dat results/a.out results/b.out

This would also require a change a few commands further down, when we create the .gitignore. As this file needs to reside in the root of the repository, we would need:
nano ../.gitignore or nano ~/Desktop/planets/.gitignore

@kekoziar
Copy link
Contributor

kekoziar commented Jul 5, 2021

Hi, @mwakok. Will you clarify your proposal? I'm not sure what you are stating in your opening paragraphs.

In terms of a structure, I'm partial to the one proposed by Good enough practices in scientific computing, which has data and results as different folders. Usually when I teach the lesson and get to creating the files for the "ignoring things" episode, I use it as an opportunity to touch on best practices for project organization.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:need more info More information needed
Projects
None yet
Development

No branches or pull requests

2 participants